Skip to content

Commit

Permalink
WIP: NVIDIA Jetson docs
Browse files Browse the repository at this point in the history
Document how to use NVIDIA JetPack 6.0 as "Side Car" to SLES/SLM.

Signed-off-by: Andreas Färber <[email protected]>
  • Loading branch information
afaerber committed May 28, 2024
1 parent 67c8724 commit 5b8e504
Show file tree
Hide file tree
Showing 5 changed files with 617 additions and 0 deletions.
17 changes: 17 additions & 0 deletions DC-nvidia-jetson
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# This file originates from the project https://github.com/openSUSE/doc-kit
# This file can be edited downstream.

MAIN="nvidia-jetson.asm.xml"
# Point to the ID of the <structure> of your assembly
ROOTID="nvidia-jetson"
SRC_DIR="articles"
IMG_SRC_DIR="images"

PROFCONDITION="suse-product"
#PROFCONDITION="suse-product;beta"
#PROFCONDITION="community-project"

STYLEASSEMBLY="/usr/share/xml/docbook/stylesheet/nwalsh5/current/assembly/assemble.xsl"

STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"
234 changes: 234 additions & 0 deletions articles/nvidia-jetson.asm.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,234 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
<!-- This file can be edited downstream. -->
<!DOCTYPE assembly
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<assembly version="5.2" xml:lang="en"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns="http://docbook.org/ns/docbook">
<!-- resources section references all topic chunks used in the final article
-->
<!-- R E S O U R C E S -->
<!-- Glue files -->
<!--<resources>
<resource xml:id="_glue-example" href="../glues/glue.xml">
<description>Glue example</description>
</resource>
<resource xml:id="_glue-more-info" href="../glues/glue-more-info.xml">
<description>Glue for more information</description>
</resource>
<resource xml:id="_glue-whats-next" href="../glues/glue-whats-next.xml">
<description>Glue what's next</description>
</resource>
</resources>-->
<!-- Concept files -->
<!--<resources>
<resource xml:id="_concept-example" href="../concepts/gpio.xml">
<description>Concept example</description>
</resource>
</resources>-->
<!-- Tasks -->
<resources>
<resource xml:id="_nvidia-jetson-sidecar-kmp" href="../tasks/nvidia-jetson-kmp.xml">
<description>KMP</description>
</resource>
<resource xml:id="_nvidia-jetson-sidecar-libs" href="../tasks/nvidia-jetson-libs.xml">
<description>Libraries</description>
</resource>
</resources>
<!-- References -->
<!--<resources>
<resource xml:id="_reference-example" href="../references/reference.xml">
<description>Reference example</description>
</resource>
</resources>-->
<!-- Legal -->
<resources>
<resource href="../common/legal.xml" xml:id="_legal">
<description>Legal Notice</description>
</resource>
<resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl">
<description>GNU Free Documentation License</description>
</resource>
</resources>
<!-- S T R U C T U R E -->
<structure renderas="article" xml:id="nvidia-jetson" xml:lang="en">
<merge>
<title>NVIDIA Jetson platform (TBD)</title>
<subtitle>Subtitle if necessary</subtitle>
<!-- Create revision history to enable versioning; add most recent entries at the top. -->
<!-- Check https://documentation.suse.com/style/current/single-html/docu_styleguide/#sec-revhistory for detailed instructions-->
<revhistory xml:id="rh-nvidia-jetson">
<revision><date>2054-11-14</date>
<revdescription>
<itemizedlist>
<!-- Group by type of change (added/removed/changed)-->
<listitem><para>Added sections:</para>
<itemizedlist>
<!-- Reference, but don't link to tracker items-->
<!-- Follow https://en.opensuse.org/openSUSE:Packaging_Patches_guidelines#Current_set_of_abbreviations for tracker item references-->
<listitem><para>New section on <quote>foo</quote> to resolve issue <uri>bsc#12345</uri></para></listitem>
<!-- Name sections, but don't insert links -->
<listitem><para>New section on <quote>foo bar</quote></para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Removed sections:</para>
<itemizedlist>
<listitem><para>Removed section on <quote>foo1</quote> to resolve issue <uri>bsc#12346</uri></para></listitem>
<listitem><para>Removed section on <quote>foo1 bar</quote></para></listitem>
</itemizedlist>
</listitem>
<listitem><para>Changed sections:</para>
<itemizedlist>
<listitem><para>Changed section on <quote>foo2</quote> to resolve issue <uri>bsc#12347</uri></para></listitem>
<listitem><para>Changed section on <quote>foo2 bar</quote></para></listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</revdescription>
</revision>
</revhistory>
<!-- TODO: provide a listing of possible and validatable meta entry values. Maybe in our geekodoc repo? -->
<!-- add author's e-mail -->
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<!-- ISO date of last update as YYYY-MM-DD -->
<meta name="updated" content="2037-11-16" its:translate="no"/>
<!-- this does not work yet. Use the dm tags listed below for now
<meta name="bugtracker" its:translate="no">
<phrase role="url">https://bugzilla.suse.com/enter_bug.cgi</phrase>
<phrase role="component">Non-product-specific documentation</phrase>
<phrase role="product">Smart Docs</phrase>
<phrase role="assignee">[email protected]</phrase>
</meta>
-->
<!-- not supported, yet. Use dm: tag for now
<meta name="translation" its:translate="no">
<phrase role="trans">yes</phrase>
<phrase role="language">de-de,cs-cz</phrase>
</meta>
-->
<!-- enter the platform identifier or a list of
identifiers, separated by ; -->
<!-- For a full list of meta tags and their values,
see https://confluence.suse.com/x/aQDWNg
-->
<meta name="architecture">
<phrase>&aarch64;</phrase>
</meta>
<!-- enter one or more product names and version -->
<meta name="productname" its:translate="no">
<productname version="15.6">&sles;</productname>
<productname version="6.0">&slm;</productname>
</meta>
<meta name="title" its:translate="yes">short title for SEO and social media, max. 55 chars</meta>
<meta name="description" its:translate="yes">short description, max. 150 chars</meta>
<meta name="social-descr" its:translate="yes">ultrashort description for social media, max 55 chars</meta>
<!-- suitable categories -->
<meta name="category">
<phrase>3rd Party</phrase>
<phrase>Systems Management</phrase>
</meta>
<!-- Determines "filter by task" filter value -->
<meta name="task">
<phrase>Configuration</phrase>
<phrase>Deployment</phrase>
<phrase>Installation</phrase>
</meta>
<meta name="series">Products &amp; Solutions</meta>

<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
<dm:bugtracker>
<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
<dm:component>Smart Docs</dm:component>
<dm:product>Documentation</dm:product>
<!-- provide your BUGZILLA e-mail address, otherwise this does not work correctly-->
<dm:assignee>[email protected]</dm:assignee>
</dm:bugtracker>
<dm:translation>yes</dm:translation>
</dm:docmanager>
<abstract>
<variablelist>
<varlistentry>
<term>WHAT?</term>
<listitem>
<para>
How to combine &suse; and third-party software for &nvidiareg; &jetson; platforms
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>WHY?</term>
<listitem>
<para>
&suse; Linux software can install on &nvidia; &jetson; systems
but does not include drivers for all hardware functionality.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>EFFORT</term>
<listitem>
<para>
What's the effort one has to put in?
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GOAL</term>
<listitem>
<para>
Fully exploit &nvidia; &jetson; hardware capabilities
while enjoying &suse; software security and support services
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>REQUIREMENTS</term>
<listitem>
<itemizedlist>
<listitem>
<para>
&nvidia; &jetson; based system with &nvidia; &orin; chipset
</para>
</listitem>
<listitem>
<para>
&nvidia; &jetpack; 6.0 software
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</abstract>
</merge>
<!-- pull in all the topic files you need -->
<!-- pick the appropriate type of include to match your needs -->
<!-- pull in a topic as is -->
<!--<module resourceref="_glue-example" renderas="section"/>-->
<!-- pull in a topic and switch the title -->
<!--<module resourceref="_concept-example" renderas="section">
<merge>
<title>You are a very special concept now!</title>
</merge>
</module>-->
<module resourceref="_nvidia-jetson-sidecar-kmp" renderas="section"/>
<module resourceref="_nvidia-jetson-sidecar-libs" renderas="section"/>
<!--<module resourceref="_reference-example" renderas="section"/>
<module resourceref="_glue-more-info" renderas="section"/>
<module resourceref="_glue-whats-next" renderas="section"/>-->
<module resourceref="_legal"/>
<module resourceref="_gfdl">
<output renderas="appendix"/>
</module>
</structure>
</assembly>
7 changes: 7 additions & 0 deletions common/generic-entities.ent
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ use &deng;! -->
<!ENTITY ms "Microsoft">
<!ENTITY msreg "<trademark xmlns='http://docbook.org/ns/docbook' class='registered'>&ms;</trademark>">
<!ENTITY nvidia "NVIDIA">
<!ENTITY nvidiareg "&nvidia;*">
<!ENTITY rh "Red Hat">
<!ENTITY redhat "&rh;">
<!ENTITY sap "SAP">
Expand All @@ -200,6 +201,12 @@ use &deng;! -->
<!ENTITY rhla "RHEL">
<!ENTITY rpios "Raspberry&nbsp;Pi&nbsp;OS">
<!ENTITY centos "CentOS">
<!-- NVIDIA products -->
<!ENTITY cuda "CUDA">
<!ENTITY jetson "Jetson">
<!ENTITY jetpack "JetPack">
<!ENTITY xavier "Xavier">
<!ENTITY orin "Orin">



Expand Down
Loading

0 comments on commit 5b8e504

Please sign in to comment.