SUSE Technical Reference Documentation Contributors Guide #

Contributors to SUSE TRD need the following:

The SUSE TRD GitHub repository is an organized collection of source files for each document. You can learn more about types of source files and how they are organized in Section 5, “Repository structure”.

Contributors use a Git workflow with the following major steps:

Each of these steps is explored in more detail in the following sections.

4.1 Fork the SUSE TRD repository #

 

The first step is to create a fork of the SUSE TRD repository into your own GitHub account. This only needs to be done once.

Note

If you work for SUSE or a partner company, use your company-sanctioned GitHub account.

1. Open your Web browser and log into your GitHub account.

2. Navigate to the SUSE TRD GitHub repository.

3. Fork this repository into your own account.

   1. In the GitHub UI, click Fork, then + Create a new fork.

      

   2. In the Create a new fork dialog, you can keep the defaults.

      

   3. Click Create fork.

4. If you are working with others on your document, you can invite them to collaborate in your repository fork.

   
   

   Note

   Alternatively, others can fork your fork and follow a similar workflow and submit content and suggestions to you through pull requests.

   1. Navigate to your fork.

   2. Click Settings > Colaborators > Add people.

   3. Enter the GitHub username, full name, or email address of your collaborator into the search field, then select the individual you wish to add.

      

      Warning

      Be sure to verify that you select the correct individual.

      SUSE employees should use approved GitHub accounts associated with their SUSE email addresses. Partner contributors should use GitHub accounts associated with their employer email account.

   4. Click Add to this repository.

4.3 Make a branch #

 

Branches help you keep your work separate from that of others. Think of a branch as an independent, project work area. You create your document in a branch of your fork. Later, you submit a pull request to merge this branch into the 'main' upstream branch.

1. Create a branch for your project.

   For example,

   git branch my-tuxy-project

2. To work in this branch, you have to check it out.

   git checkout my-tuxy-project

Tip

You can create and check out a branch at the same time with:

git checkout -b my-tuxy-project

Important

It is a good practice to make sure your branch is active at the start of each editing session. You can verify your current branch with:

git branch --show-current

4.5 Create content #

 

Good documentation often results from collaborative efforts and multiple editing sessions. The following workflow can help you manage this process.

1. Enter the local directory containing the clone of your GitHub fork. For example:

   cd ~/git/GITHUB_USER/technical-reference-documentation

2. Check out your project’s branch.

   git checkout my-tuxy-project

   

   Tip

   Always remember to work in your branch.

3. Update the clone from your origin remote.

   This allows you to integrate any edits or other content from your contributors, helping you minimize merge conflicts later.

   git pull origin

   

   Note

   It is not necessary to specify the origin remote, since it is configured as your default for tracking.

   

   Important

   Fix any merge errors before proceeding.

4. Create your content.

   A typical content session involves editing source files and copying assets (such as image files) into appropriate project directories. Be sure to refer to Section 7, “Style” and Section 8, “AsciiDoc” to learn more about writing style and content formatting.

5. Render your document with DAPS to verify content, layout, and style.

   

   Note

   You may get validation errors if you have invalid AsciiDoc syntax. You must then find and correct these errors.

6. Commit your changes locally.

   For example:

   git add .
   git commit -m "updated section 5; added screenshot"

   

   Tip

   Always include a commit message as a reminder to yourself and to let your collaboration team know what changes you made in this commit.

7. Push the commit to your origin remote.

   git push origin

   

   Note

   The first time you push a commit on your branch, you will see a warning like:

   fatal: The current branch my-tuxy-project has no upstream branch.
   To push the current branch and set the remote as upstream, use
   
       git push --set-upstream origin my-tuxy-project
   
   To have this happen automatically for branches without a tracking
   upstream, see 'push.autoSetupRemote' in 'git help config'.

   Simply follow the instructions to fix the issue.

   You only need to do this once.

8. Repeat these steps until you are finished with new content.

Tip

It is a good idea to break up long content creation sessions. Pause frequently to commit and push edits to your origin remote.

SUSE TRD is both a website with links to published documents and a GitHub repository of their source files. As a contributor, you need a general understanding of the structure of the source repository.

The repository’s top-level directories are:

├── common
│   ├── adoc
│   ├── bin
│   ├── images
│   └── templates
├── kubernetes
│   ├── enterprise
│   ├── reference
│   └── start
└── linux
    ├── enterprise
    ├── reference
    └── start

Inside the linux and kubernetes directories, are directories for the document types:

5.1 Getting started guide structure #

 

A getting started guide features a combination of components by one or more "entities," such as SUSE, a partner company, or an open source project. The source files used to generate these guides are maintained under the linux/start or kubernetes/start directories, depending on the primary implementation focus. Guide files are further organized into directories named for a featured entity. This is typically the provider of the component at the highest layer of the technology stack and closest to the user’s workload or use case. Thus, for example, you find directories for Kubeflow, MongoDB, Ondat, and so on.

start
├── bin
├── kubeflow
├── minio
├── mongodb
├── ondat
├── suse
├── sysdig
├── upbound
└── veeam

Note

The bin directory contains scripts to help contributors perform various tasks.

Inside an "entity" directory, you find further structure. For example:

veeam
├── DC-gs_rancher_veeam-kasten 1
├── adoc 2
│   ├── common_gfdl1.2_i.adoc -> ../../../../common/adoc/common_gfdl1.2_i.adoc
│   ├── ...
│   ├── gs_rancher_veeam-kasten.adoc 3
│   └── gs_rancher_veeam-kasten-docinfo.xml 4
├── images -> media
└── media 5
    └── src
        ├── png
        │   ├── rancher_veeam-kasten_k10_dashboard-welcome.png
        │   ├── ...
        │   └── rancher_veeam-kasten_architecture-1.png
        └── svg
            ├── logo-lockup_rancher-by-suse_kasten-by-veeam_hor_dark.svg
            └── suse.svg -> ../../../../../../common/images/src/svg/suse.svg

1	Doc Config (DC) file: There is one DC file for each documentation deliverable in which you specify parameters that define the name of the main content file, the rendering stylesheet, the revision date, and so on.
2	adoc directory: Contains your AsciiDoc content files and your DocBook metadata file.
3	Main content file: This plain text file, formatted with the AsciiDoc markup language, is where you write most of the text of your document. You can use the include directive to merge content from other AsciiDoc files during the rendering process.
4	DocBook metadata (docinfo.xml) file: This file specifies metadata about your document, including title, author information, cover logo file, and executive summary. Much of this information is actually defined as document attributes (variables) in your main content file and referenced here to save you from having to type the same information twice.
5	media directory: You can include logos, diagrams, screenshots, and other images in your guides. These media files are stored in subdirectories by file type under media/src. Many image file types are supported, but preference is given to: Scaled Vector Graphics or 'SVG' is a widely-deployed, royalty-free, vector graphics format developed and maintained by the W3C. A vector graphics image is rendered from a set of instructions that defines the image from basic, geometric shapes. This allows SVGs to be resized without loss of clarity. SVGs are typically used for logos and architectural diagrams. Portable Network Graphics or 'PNG' is a raster graphics format. A raster image encodes information (like position, color, or brightness) for each pixel (picture element) that makes up the image. PNG uses lossless compression, allowing PNGs to be edited and resaved without loss of clarity (unlike Joint Photographic Experts Group or 'JPEG' images). Scaling raster images can introduce artifacts. This is particularly apparent when images are enlarged. Choose image resolutions to minimize these artifacts. Note In the "entity" directory, images is a symbolic link to the media directory, and is used to maintain compatibility with existing processes and tooling.

You can learn more about Doc Config, AsciiDoc, and DocBook metadata files in Section 6, “Templates and framework”.

Your SUSE TRD documentation project relies on different types of source files, placed in specific locations within the repository’s directory structure. The files and structures can be created from scratch. But you can use the provided automation tools to generate a framework for you, including templates for your source files.

6.1 Getting started guides #

 

Getting started guides are relatively simple documents, but they do require multiple files located in a specific directory structure. You can create this structure and the requisite files manually, but the gssetup.sh script is available to help automate the process.

6.1.1 Generating the framework #

 

1. Open a local terminal and change to the directory containing your clone.

   cd ~/git/GITHUB_USER/technical-reference-documentation

2. If you have not done so already, create a branch for your project.

   git branch my-tuxy-project

3. Check out your project branch.

   git checkout my-tuxy-project

4. Change to either the kubernetes/start/ or linux/start/ subdirectory.

   For example:

   cd kubernetes/start

   

   Tip

   Linux is likely a part of every solution, but, if any portion of SUSE’s Enterprise Container Management portfolio is involved, the documentation should be created in the kubernetes directory tree.

5. Execute the setup script to generate directory structures and basic files from templates.

   ./bin/gssetup.sh

6. Verify that you have performed the prerequisite actions presented in the banner, then press ENTER to continue.

   = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
   = Set up workspace for new TRD getting started guide        =
   = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
   
    This script will prompt you for information about your
    guide, then use your responses to create the directories
    and template files for your guide
   
     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
     - Before proceeding make sure you have:
     - 1. created a local branch: `git branch myproject`
     - 2. checked out your new branch: `git checkout myproject`
     - 3. changed to the 'kubernetes/start' or
     -    'linux/start' directory (as appropriate)
     - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
   
   Are you ready to proceed?
   Press ENTER to continue or CTRL+C to cancel.

   

   Note

   The setup script makes the following checks:

   • that you do not have the main branch checked out

   • that your current working directory is either kubernetes/start or linux/start

7. Identify the primary SUSE product name.

   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
   - Gathering some information
   - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
   
   - - - - - -
   - Identify the featured SUSE products by entering
   - one product abbreviation at a time.
   - When done, press ENTER with no value.
   -
   - TIP: Start at the top of the software stack.
   -      For example: 'rancher' then 'rke2' then 'sles'
   -
   - Additional options:
   -   'list': display accepted abbreviations.
   -   'clear': clear the product list and start over.
   -   Press CTRL+C to cancel and exit the script.
   - - - - - -
   
   >> SUSE product : rancher

   

   Note

   Accepted SUSE product abbreviations are listed in the table below.

   Abbreviation	Product name
   sles	SUSE Linux Enterprise Server
   slessap	SUSE Linux Enterprise Server for SAP Applications
   slehpc	SUSE Linux Enterprise High Performance Computing
   slemicro	SUSE Linux Enterprise Micro
   slelp	SUSE Linux Enterprise Live Patching
   slert	SUSE Linux Enterprise Real Time
   sleha	SUSE Linux Enterprise for High Availability
   slebci	SUSE Linux Enterprise Base Container Images
   suma	SUSE Manager
   rancher	Rancher Prime by SUSE
   neuvector	NeuVector Prime by SUSE
   harvester	Harvester by SUSE
   rke	Rancher Kubernetes Engine
   rke2	Rancher Kubernetes Engine 2
   k3s	K3s by SUSE
   longhorn	Longhorn by SUSE

8. Identify a primary partner.

   - - - - - -
   - Enter the name of the primary partner.
   -
   - TIP: Select one partner whose product is at the top
   -      of the software stack and provides the key
   -      functionality for the featured use case.
   - - - - - -
   
   >> Primary partner : tuxy

   

   Note

   In general, the product at the highest layer of the software stack is key for addressing the use case. Enter the name of the provider of this product as the primary partner.

   The primary partner name is used to help organize the documentation in the repository’s directory structure and also appears in the names of some source files as well as in the URL of the published guide. If it is necessary to include additional partner names, this can be done in a manual process after running this script.

9. Identify the primary partner’s product.

   - - - - - -
   - Enter the name of the primary partner's product.
   -
   -   TIP: If the primary partner and the product
   -        share the same name, you can leave the
   -        partner product blank to avoid repetition.
   -
   - - - - - -
   
   >> Primary partner's product : penguin

   

   Note

   The primary partner product name appears in file names and the URL of the published guide. If you need to include multiple products by the primary partner, list each one separated by a hyphen (-).

10. Optionally enter a use case or description.

    - - - - - -
    - OPTIONAL
    -
    - If a solution can address multiple use cases,
    - it may be useful to create a separate guide to
    - address unique concerns of each use case.
    - Since the product stack is insufficient to distinguish
    - each guide, some additional text can be added to the
    - file name.
    -
    -   TIP: It is preferable to leave this blank.
    -        If needed, use fewer than 20 characters for the
    -        additional text.
    - - - - - -
    
    >> Distinctive text :

    

    Note

    This descriptive text appears in file names and the URL of the published guide.

    It can be useful to distinguish guides targeting different use cases with the same solution stack.

    You can also use this distinctive text to list an additional partner and product, but be sure to separate these with a hyphen (-).

    In most cases, you should leave this entry blank.

11. Review the proposed structure and naming.

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      - Preparing to create the following structure:
      -
      -   /home/terry/git/technical-reference-documentation/kubernetes
      -   └── start
      -       └── tuxy
      -           ├── DC-gs_rancher_tuxy-penguin
      -           ├── adoc
      -           │   ├── gs_rancher_tuxy-penguin.adoc
      -           │   ├── gs_rancher_tuxy-penguin-docinfo.xml
      -           ├── images -> media
      -           └── media
      -               └── src
      -                   ├── png
      -                   └── svg
      -
      - NOTE: Several symbolic links will also be created.
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    
    >> Press ENTER to create document structure or CTRL+C to cancel.
    
    = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
    = Workspace for your new guide has been set up.
    =
    = Access your workspace in:
    =   /home/terry/git/tls/technical-reference-documentation/kubernetes/start/tuxy
    = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =

    

    Note

    No directories or files are created until you press ENTER. If you press CTRL+C, you cancel the planned operations and return to the command line.

12. Confirm that the structure has been created as intended.

    cd tuxy
    tree .

    tree .
    .
    ├── adoc
    │   ├── common_docinfo_vars.adoc -> ../../../../common/adoc/common_docinfo_vars.adoc
    │   ├── common_gfdl1.2_i.adoc -> ../../../../common/adoc/common_gfdl1.2_i.adoc
    │   ├── common_sbp_legal_notice.adoc -> ../../../../common/adoc/common_sbp_legal_notice.adoc
    │   ├── common_trd_legal_notice.adoc -> ../../../../common/adoc/common_trd_legal_notice.adoc
    │   ├── gs_rancher_tuxy-penguin.adoc
    │   └── gs_rancher_tuxy-penguin-docinfo.xml
    ├── DC-gs_rancher_tuxy-penguin
    ├── images -> media
    └── media
        └── src
            ├── png
            └── svg
                └── suse.svg -> ../../../../../../common/images/src/svg/suse.svg
    
    7 directories, 8 files

6.1.2 Understanding the templates #

 

The gssetup.sh script creates the standard directory structure, symbolic links to common files, and the three principal files you will edit for your document. These three files include copious comments to help you understand how to use them. The following sections provide some highlights.

6.1.2.1 Doc Config (DC) file #

 

The DC file (DC-gs_rancher_tuxy-penguin in the example) is located in the root of the generated partner directory. It specifies parameters that define how the document will be rendered.

As a contributor, you only need to be concerned with two of these parameters:

DRAFT=yes

Specifies that the document is in draft mode and watermarks the document accordingly.

Important

When you are ready to submit your document for final review, you must comment out this parameter by preceding it with a hash mark:

#DRAFT=yes

MAIN="gs_rancher_tuxy-penguin.adoc"

Specifies the AsciiDoc file with the main contents of your guide.

Note

This parameter is set by the gssetup.sh script. You only need to change it if you rename the main document file.

6.1.2.2 DocBook metadata (docinfo) file #

 

The docinfo file (gs_rancher_tuxy-penguin-docinfo.xml, in the example) is located in the adoc subdirectory. It defines metadata about your document, such as title and subtitle, brief descriptions, featured products and partners, authors, and even which logo to feature on the cover page. You only need to edit the docinfo file if you need to add metadata tags that are not already defined.

Important

The docinfo file references attributes (variables) defined in your AsciiDoc file. These appear in the docinfo file as words (or any sequence of characters, like "scomp1-version") enclosed in curly braces ( { and } ).

All referenced attributes must be defined in your AsciiDoc file. Otherwise, your document will fail to render.

The docinfo template provides metadata tags for only one SUSE product, but you can easily add metadata for additional SUSE products.

<meta name="productname"> 1
  <productname version="{scomp1-version}">{scomp1}</productname> 2
</meta>
<meta name="platform">{scomp1-full}</meta> 3

1	The <meta name="productname"> </meta> tag pair encloses the list of named SUSE products.
2	List each product with a separate <productname> </productname> entry. For example, to include a second SUSE product, you would add a new tag pair below the first: <productname version="{scomp2-version}">{scomp2}</productname> where: scomp2 must be defined in your AsciiDoc file with the short name (or official abbreviation) for the SUSE product scomp2-version must be defined in your AsciiDoc file with the relevant versions or versions of the SUSE product
3	The primary SUSE product is identified with the <meta name="platform"> </meta> tag pair. The scomp1-full attribute, defined in your AsciiDoc file, must be the full SUSE product name.

List technical partners (those companies or organizations) supplying components featured in the solution with:

<meta name="techpartner">
  <phrase>{pcomp1-provider}</phrase>
</meta>

Identify the document author or authors in the <authorgroup> </authorgroup>.

<authorgroup>
  <author> 1
    <personname> 2
      <firstname>{author1-firstname}</firstname>
      <surname>{author1-surname}</surname>
    </personname>
    <affiliation> 3
      <jobtitle>{author1-jobtitle}</jobtitle>
      <orgname>{author1-orgname}</orgname>
    </affiliation>
  </author>
</authorgroup>

1	Each author’s information is enclosed in <author> </author> tag pairs. To add another author, replicate the contents in a new <author> </author> tag pair and update the attribute references.
2	Include first (or given) name and surname (family name).
3	Include company, organization, or project affiliation along with job, position, or role title.

Note

The authors identified in this section are displayed on the rendered document.

You can also acknowledge the contributions of editors and others in an "Acknowlegement" section of your AsciiDoc file.

The last section of the docinfo file you may want to edit identifies the logo that appears on the cover image.

<cover role="logos">
  <mediaobject>
    <imageobject role="fo">
      <imagedata fileref="suse.svg" width="5em"/>
    </imageobject>
    <imageobject role="html">
      <imagedata fileref="suse.svg" width="152px"/>
    </imageobject>
  </mediaobject>
</cover>

The default logo is the official SUSE company logo, which is always appropriate for all SUSE Technical Reference Documentation. If you wish, you can specify a logo "lock-up" or "mash-up" by updating the "fileref" option with the name of the appropriate image file.

Note

You must have documented approval from the partner before using the logo and the usage must follow SUSE and partner branding guidelines.

6.1.2.3 Main AsciiDoc (asciidoc) content file #

 

The text of your document is contained in one or more AsciiDoc (adoc) files, located in the adoc subdirectory. For a getting started guide, you typically put all your content in a single adoc file (gs_rancher_tuxy-penguin.adoc in the example). This is the file specified in the DC file with the MAIN parameter.

Tip

There are many reasons you might want to split your contents into multiple adoc files, such as to organize more complex documents or to make it easier for multiple contributors to work independently on different sections. If you choose to split your document, you will need to use the AsciiDoc include directive to link all the files so the content is properly merged in a single rendered document.

Document attributes and variables

Document attributes are name-value pairs you declare in your adoc file. Attributes enable you to configure the AsciiDoc processor, declare document metadata, and define reusable content that you can reference elsewhere within the document like variables in a programming language.

You define an attribute with the following pattern:

:name-of-attribute: value of attribute

• The attribute name is preceded and followed by a colon (:). Attribute names should begin with a letter and may include numbers, hyphens, and underscores.

• The value of the attribute can include any text up to a new line character.

  

  Tip

  There must be a space between the closing colon of the attribute name and the first character of the value text.

The adoc template provides a guide for defining your document attributes and variables.

Some attributes are required, such as:

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// ORGANIZATION
//   Do NOT modify this section.
// -
:trd: Technical Reference Documentation 1
:type: Getting Started 2
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

1	Declares this document as part of SUSE Technical Reference Documentation.
2	Declares this document to be a getting started guide.

You also specify the document revision date in a variable:

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// DOCUMENT REVISION DATE
//-
:revision-date: YYYY-MM-DD 1
:docdate: {revision-date} 2
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

1	Be sure to enter the date you revised the document in the specified format.
2	The docdate attribute, which is used by some processes, simply references the value of the revision-date attribute.

Your document title and subtitle are defined with:

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// DOCUMENT TITLE AND SUBTITLE
:title: (<75 characters) Your Guide Title
:subtitle: (<75 characters) Your Guide Subtitle
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

See Section 8.3, “Document title and subtitle” for additional guidance.

You also define document attributes for the technical components featured in your guide. This allows you to define product names, versions, website URLs, and more, then reference these throughout your guide to reduce typing, ensure consistency, and minimize errors.

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// TECHNICAL COMPONENTS

:comp1-provider: SUSE 1
:comp1: component 1 short name 2
:comp1-full: component 1 long name 3
:comp1-version: component 1 relevant versions 4
:comp1-website: component 1 product website URL 5
:comp1-docs: component 1 product documentation URL 6

:comp2-provider: component 2 provider name 7
:comp2: component 2 short name
:comp2-full: component 2 full name
:comp2-version: component 2 relevant versions
:comp2-website: component  product website URL
:comp2-docs: component 2 product documentation URL
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

1	Identify the company or organization providing the component.
2	Provide an official short name for referring to the component. SUSE products have official short names, such as SLES, SUMa, Rancher, and so on. Other providers may have official short names. Be sure to verify for proper branding.
3	Provide the official full name of the component product. Some SUSE products include: SUSE Linux Enterprise Server, SUSE Manager, Rancher Prime by SUSE, NeuVector Prime by SUSE, and so on.
4	Provide the relevant version or versions of the component. Guides are developed with a specific version, such as '15 SP5' for SLES or '2.7.9' for Rancher. However, the guide may be applicable to multiple versions of the component. This should be indicated whenever possible, either by listing all relevant versions ('15 SP4, 15 SP5', '2.7.8, 2.7.9') or by indicating a range ('15 SP4+', '2.7.X').
5	Provide a product (or project) website URL (for example, 'https://www.suse.com/products/server/'). By setting the URL in a document attribute, you can easily update it in one place, if needed, and reference it throughout your document.
6	Provide the URL to the component’s technical documentation.
7	Replicate the attribute declarations for each of the major components.

Document desriptions express the purpose, value, and contents of your guide.

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// DOCUMENT DESCRIPTIONS

:usecase: (<55 characters) use case 1

:description: (<150 characters) description 2

:description-short: (<55 characters) social media description 3

:executive-summary: (<300 characters) brief summary 4

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

1	Provide a brief statement of the use case addressed by your guide, such as "database-as-a-service" or "Kubernetes multi-tenancy".
2	Give a brief description of the guide. This can reference usecase or other attributes you have already defined.
3	Shorten the description so that it might be used in a social media post.
4	Provide an executive summary of your guide. The executive summary is the only one of these descriptions that is automatically printed in the published document.

Identify yourself and other authors. For each include first and last names, job title, affiliation (company, organization, project, etc.). For additional authors, you must also update the contents of the <authorgroup></authorgroup> section of the docinfo file for the authors to be listed.

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// CONTRIBUTORS
:author1-firstname: first (given) name
:author1-surname: surname
:author1-jobtitle: job title
:author1-orgname: organization affiliation
//:author2-firstname: first (given) name
//:author2-surname: surname
//:author2-jobtitle: job title
//:author2-orgname: organization affiliation
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Tip

To identify other contributors and editors, use the same format for the variable names, but replace 'author' with 'contrib' or 'editor'. It is common to mention contributors and editors in an "Acknolwedgements" section of your guide.

Document attributes can be incredibly useful for maintaining consistency, reducing errors, and saving a little typing. A portion of this part of the guide is available for you to define any additional attributes you need.

// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// MISCELLANEOUS
//   Define any additional variables here for use within the document.
// -


// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

6.1.2.4 Contents #

 

After defining document attributes, you can begin developing your content. The adoc template generated by the gssetup.sh script provides an outline for a general getting started guide. You will find that the template is copiously documented with guidance and suggestions.

In general a getting started guide is structured as follows:

• Title page

  In addition to title and subtitle, products and authors are also listed.

• Disclaimer page

  The disclaimer is provided, along with the title, subtitle, revision date, and the executive summary.

• Contents

  A table of contents is created from the top-level sections of your document.

• Introduction

  The first actual contents of your guide is an introduction that briefly but clearly describes:

  • what the solution is, including the participating providers and products

  • the motivation, purpose, or use case is being addressed

  The Introduction contains a few important subsections:

  • Scope

    This is a clear list or statement of what the guide covers and (sometimes) what it does not cover.

  • Audience

    Identify who would be most interested or helped by the information provided. This intended audience is typically by industry standard roles, such as systems administrator, cloud-native developer, infrastructure architect. You should list the knowledge and skills the reader should have to successfully follow the guide.

  • Acknowledgements

    Acknowledge others who contributed to the development of the guide.

• Prerequisites

  List the resources the reader will need in order to follow the procedures detailed in the guide. You typically use an unordered list for these resources. For each, include product name, versions, link to product website, and any other information to help the reader set up the environment.

• Procedure

  Your guide should detail the procedure the reader should follow to prepare, install, configure, and validate the components of the solution. Each of these phases can be rendered into its own section, such as:

  • Setting up your environment

  • Installing the components

  • Configuring and tuning your installation

  • Validating your deployment

  

  Tip

  Dividing a complex series of steps into subsections can make it easier for the reader to follow. For example, an 'Installing the solution' section might have subsections for installing each component.

• Summary

  Briefly review the solution, motivation, and what was covered in the guide. You may also consider offering suggested next steps for the reader to continue the learning journey.

SUSE TRD is part of the SUSE Documentation ecosystem. Its objective is to provide well-structured, clear, and concise technical information in a way that facilitates real-world problem-solving. Consistent writing style and formatting contribute to the creation of high quality documentation.

Writing style goes beyond the essential elements of spelling, grammar, and punctuation to include tone of voice, choice of words, sentence and paragraph structure, and more.

Keep in mind the following general writing style guidance as you create your documentation for SUSE TRD:

For more on writing effective technical documentation, see the SUSE Documentation Style Guide.

SUSE TRD documentation is rendered from plain text files. Formatting (including structure and text styling) is indicated with AsciiDoc. This is a lightweight and semantic markup language with an intuitive syntax that is primarily designed for writing technical documentation.

 :name-of-an-attribute: value of the attribute

 :comp1-full: Rancher Prime by SUSE
 :comp1-website: https://www.suse.com/solutions/enterprise-container-management/#rancher-product
 :comp2-full: Kubeflow
 :kubeflow_website: https://www.kubeflow.org/
 :title: Deploy {comp2-full} with {comp1-full}
 :executive-summary: Learn how to deploy {comp2-website}[{comp2-full}] to a cluster managed by {comp1-website}[comp1-full}.

 = My Document Title: My Document Subtitle

 :title: Rancher by SUSE and Priority Support on AWS Marketplace
 :subtitle: Deploy Rancher on Elastic Kubernetes Service (EKS)

 = {title}: {subtitle}

 <title>{title}</title>
 <subtitle>{subtitle}</subtitle>

 == Section title level 1

 === Section title level 2

 ==== Section title level 3

 == Enabling Podman

 Podman, which is short for Pod Manager, is a daemonless, open source tool ...


 === Install Podman

 Podman is not installed by default in SLES 15, but you can install it with these steps.
 ...


 === Define subordinate UIDs and GIDs

 By default, only the root user can run Podman containers.  Running ...
 ...


 == Creating container images

 You can build an application container image ...

 === Make a build directory

 You need a place in your file system to contain ...

The `manifest.yaml` file is located in the `$HOME/my-tuxy-project` directory.

8.7 Admonitions #

 

Use admonitions are used to help draw the reader’s attention to content. AsciiDoc supports five admonition types represented by the following labels:

• NOTE: provide additional information

• TIP: suggest a helpful tip

• IMPORTANT: highlight an important point

• CAUTION: advise that care should be taken

• WARNING: inform of danger, harm, or consequences

The basic admonition style places the admonition label followed by a colon ( : ) at the beginning of a line of text. This is useful for short admonitions that do not contain a line break. For example:

 TIP: By default, some `zypper` commands perform `refresh` automatically.

This is rendered as:

Tip

By default, some zypper commands perform refresh automatically.

The block admonition style provides more flexibility for the content, as illustrated with this example:

 [IMPORTANT]
 ====
 When working with snapshots to restore data, it is important to know
 that there are two fundamentally different scenarios Snapper can handle:

 Undoing changes::
 When undoing changes as described in the following, two snapshots are
 being compared and the changes between these two snapshots are made undone.
 Using this method also allows to explicitly select the files that should be
 restored.

 Rollback::
 When doing rollbacks as described in <<System rollback>>, the system is
 reset to the state at which the snapshot was taken.

 ====

8.8 Source code, commands, and output #

 

Technical guides often need to present source code, commands, and other console output. AsciiDoc provides listing blocks for these purposes, in which text is rendered with a fixed-width font and other features to present this special content.

The basic listing block presents text verbatim. That is, text is rendered just as it is entered in terms of line and character spacing. The form of a listing block is:

 [listing]
 ----
 This   text has      really weird      spacing   that is    preserved.

 Line spacing is also preserved.
 ----

A source code block is a special version of a listing block that enables syntax highlighting, using color and text styles to distinguish code structures (such as keywords, variables, constants, comments, and so on).

To illustrate, review the following Python code snippet.

 [source, python]  1
 ----  2
 # import libraries
 import matplotlib.pyplot as plt
 import numpy as np

 # define data points
 xpoints = np.array([1, 2, 5, 12])
 ypoints = np.array([5, 3, 11, 6])

 plt.plot(xpoints, ypoints)
 plt.show()
 ----

1	[source, python] identifies this as a source code block and the source language as Python. Some common source language identifiers are: bash, c, html, python, sql, yaml, and xml.
2	---- delimits the beginning and end of the block.

Note

As with ordinary listing blocks, line spacing is preserved.

Commands entered on the command line are like source code, so they are handled with source code blocks but with console as the source language identifier. For example:

 [source, console]
 ----
 sudo zypper install vim
 ----

Commands can also be included inline with other text by using grave accents (or back ticks) to enclose the command, as in:

 Use `zypper refresh` to update your enabled repositories.

A helpful feature of AsciiDoc is that document attributes can be referenced inside your source code blocks. You do this with the subs option. Consider this example:

 // attribute in your document
 :myPath: /home/geeko/myproject/

 // attribute referenced in source code block
 [source, console, subs="attributes+"]
 ----

  tree {myPath}

 ----

This renders as:

tree /home/geeko/myproject/

Tip

Attribute substitution can be tricky. The AsciiDoc rendering engine has no way of knowing if curly braces enclosing text in your code should be treated literally or substituted with the value of a document attribute.

In Bash, for instance, it is common to reference variables as ${myVariable}. It may be important for ${myVariable} to appear in your code as-is. However, if attribute substitutions are enabled, the rendering engine would try to find an attribute, named myVariable, and substitute its value. If there is no such attribute, the render would fail.

One way to solve this is to not use the subs="attributes+" option. But, if you need some substitutions in your code block and not others, you can use escaping to let the rendering engine know your intentions. Simply place a backslash (\) just before each of the curly braces. This lets the rendering engine know to treat the curly braces as literal characters and not as indication of an attribute reference.

Here is an example:

 :myPrompt: geeko@mangrove.lane:~/myproject:

 [source, console, subs="attributes+"]
 ----

 {myPrompt} echo "My stored value is $\{myVariable\}."

 ----

With myPrompt defined in your document, this code block would render as:

geeko@mangrove.lane:~/myproject: echo "My stored value is ${myVariable}."

For command output, use a simple listing block.

 [listing]
 ----
 Type   | # |     | Cleanup | Description           | Userdata
 -------+---+ ... +---------+-----------------------+--------------
 single | 0 |     |         | current               |
 single | 1 |     | number  | first root filesystem |
 single | 2 |     | number  | after installation    | important=yes
 single | 3 |     | number  | rollback backup of #1 | important=yes
 single | 4 |     |         |                       |
 ----

 . Open _myfile_.

 .. Click __File__ > __Open__.

 .. Select _myfile_ from the list.

 .. Click __Open__.

 https://target-URL[custom link text]

 Visit https://documentation.suse.com/[SUSE Documentation] to continue your learning journey.

 image::TARGET[ATTRIBUTES]

 image::my-tuxy-architecture.svg[Tuxy Architecture, scaledwidth="75%", align="center"]

8.12 Blocks and continuations #

 

Block elements (or blocks) are discrete, line-oriented chunks of content that form the basic structure of an AsciiDoc document.

The most common type of block is a paragraph, which is a contiguous set of lines of text, bounded by one or more blank lines. Sections, lists, and tables are also types of blocks. And, obviously, block image macros, listing blocks, code blocks, and admonitions are as well.

Tip

Blocks should always be bounded by an empty line (or document boundary), except when "attached" using list continuation.

List continuation (explicitly denoted by a plus symbol (+) by itself on the line between two blocks) can be used to join two adjacent blocks together. The most common use for this is to allow a list item to contain one or more blocks, ensuring alignment of elements.

Consider the example AsciiDoc code below.

 . Verify that `kernel-default` has been installed.
 +
 [source, console]
 ----
 sudo zypper se kernel-default
 ----
 +
 [IMPORTANT]
 ====
 After `kernel-default` has been installed, be sure to remove `kernel-default-base`.
 ====

 . Reboot each node to enable the `kernel-default` kernel.

 [TIP]
 ====
 Learn more about the `zypper` command:

 [source, console]
 ----
 man zypper
 ----
 ====

Rendered, this code looks like:

1. Verify that kernel-default has been installed.

   sudo zypper se kernel-default

   

   Important

   After kernel-default has been installed, be sure to remove kernel-default-base.

2. Reboot each node to enable the kernel-default kernel.

Tip

Learn more about the zypper command:

man zypper

Notice that the code block and IMPORTANT admonition are correctly aligned under the list item, but the TIP admonition is aligned with the document margin. As a bonus, there is a source code block inside and properly aligned with TIP admonition.

By understanding blocks and continuation, you can create complex and beautifully rendered documents.

Among the important tools for your workflow as a contributor to SUSE Technical Reference Documentation is the DocBook Authoring and Publishing Suite (DAPS). DAPS helps you author and publish documentation written in DocBook XML and AsciiDoc to a variety of different formats, such as HTML, EPUB, and PDF. It also includes tooling for validation, link checking, spell checking, and editor macros.

DAPS is dual-licensed under GPL 2.0 and GPL 3.0, and it is available as binary packages for the openSUSE and SUSE Linux Enterprise, and it can be installed from source on any Linux distribution. DAPS has several software dependencies, some of which are required and others are recommended to enable certain functionality. For details, see the System Requirements and Installation section of the DAPS User Guide.

Daps2Docker aims to simplify and expand access to the rendering capabilities of DAPS. It does this by packaging DAPS and some of its dependencies in an easy-to-use, OCI compliant container.

Below are details for installing and configuring Daps2Docker on a bare metal or virtual machine running one of the following operating systems:

Note

It should require little effort to adapt these steps for other operating systems that can run OCI-compliant containers.

9.3 Installing Daps2Docker #

 

You can install Daps2Docker with zypper on the command line.

1. Install Daps2Docker from the Documentation:Tools repository.

   sudo zypper install --repo Documentation_Tools daps2docker

Important

When you install Daps2Docker, you may see output like the following:

Problem: nothing provides 'docker' needed by the to be installed daps2docker-0.18-150400.1.1.noarch
 Solution 1: do not install daps2docker-0.18-150400.1.1.noarch
 Solution 2: break daps2docker-0.18-150400.1.1.noarch by ignoring some of its dependencies

Choose from above solutions by number or cancel [1/2/c/d/?] (c): 2

Because Podman is being used, you can safely choose to "break" this dependency by selecting option '2'.

asciidoctor: WARNING: skipping reference to missing attribute: product1

SUSE Technical Reference Documentation is a repository of high quality documentation for solutions that address real-world use cases with featured SUSE, partner, and community components.

This document provides an overview of the tools, techniques, workflows, and styles that you will use to make successful contributions to SUSE TRD.

Copyright © 2006–2024 SUSE LLC and contributors. All rights reserved.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or (at your option) version 1.3; with the Invariant Section being this copyright notice and license. A copy of the license version 1.2 is included in the section entitled "GNU Free Documentation License".

SUSE, the SUSE logo and YaST are registered trademarks of SUSE LLC in the United States and other countries. For SUSE trademarks, see https://www.suse.com/company/legal/.

Linux is a registered trademark of Linus Torvalds. All other names or trademarks mentioned in this document may be trademarks or registered trademarks of their respective owners.

Documents published as part of the series SUSE Technical Reference Documentation have been contributed voluntarily by SUSE employees and third parties. They are meant to serve as examples of how particular actions can be performed. They have been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. SUSE cannot verify that actions described in these documents do what is claimed or whether actions described have unintended consequences. SUSE LLC, its affiliates, the authors, and the translators may not be held liable for possible errors or the consequences thereof.

Copyright © 2000, 2001, 2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.

A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.

You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties—​for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.

Copyright (c) YEAR YOUR NAME.
   Permission is granted to copy, distribute and/or modify this document
   under the terms of the GNU Free Documentation License, Version 1.2
   or any later version published by the Free Software Foundation;
   with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
   A copy of the license is included in the section entitled “GNU
   Free Documentation License”.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “ with…​Texts.” line with this:

with the Invariant Sections being LIST THEIR TITLES, with the
   Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.