This is the source for the official SUSE Linux Enterprise and openSUSE Leapdocumentation.

This repository hosts the documentation sources including translations (ifavailable) for the following products:

• SUSE Linux Enterprise Desktop (SLED)

• SUSE Linux Enterprise Server (SLES)

• SUSE Linux Enterprise Micro (SLE-Micro)

• openSUSE Leap

• SLE 11 sources: seehttps://github.com/SUSE/doc-sle-legacy

Released versions of the SLE documentation are published athttps://documentation.suse.com/. Released versions of the openSUSE Leap documentation can befound athttps://doc.opensuse.org/.

Beta documentation versions are available athttps://susedoc.github.io/, where all commits tomain and maintenance branches are automatically built.

Use the main branch as the basis of your commits/of new feature branches.

Bugs are collected onhttps://bugzilla.suse.com. If possible please check forduplicates before creating a new report. When creating a new report, useSUSE Linux Enterprise Desktop orServer as product and in the next step the version.As component selectDocumentation.

Thank you for contributing to this repo. When creating a pull request, please follow the guidelines below:

1. If you want to contribute to the most recent release, create your pull request against themain branch. Themain branch is protected.

2. If you want to contribute to a previous release, please create your pull request against the respectivemaintenance/* branch. These branches are also protected.

3. Make sure all validation (GitHub Actions) checks are passed.

4. For your pull request to be reviewed, please tag the relevant subject matter expert(s) from the development team (if applicable) and members of the documentation team.

5. Implement the required changes. If you have any questions, ping a documentation team member in #team-suse-docs on Slack.

6. For help on style and structure, refer to theDocumentation Style Guide.

To contribute to the documentation, you need to write DocBook.

• You can learn about DocBook syntax athttp://docbook.org/tdg5/en/html .

• SUSE documents are generally built with DAPS (packagedaps) and theSUSE XSL Stylesheets (packagesuse-xsl-stylesheets).

• Install the documentation environment with the following command:

  sudo OneClickInstallUI https://susedoc.github.io/ymp/Documentation.ymp

• Basic DAPS usage:

  • $ daps -d DC-<YOUR_BOOK> validate: Make sure what you have written iswell-formed XML and valid DocBook 5

  • $ daps -d DC-<YOUR_BOOK> pdf: Build a PDF document

  • $ daps -d DC-<YOUR_BOOK> html: Build multi-page HTML document

  • $ daps -d DC-<YOUR_BOOK> optipng: Always optimize new PNG images

  • Learn more athttps://opensuse.github.io/daps