This is the source for the official SUSE CaaS Platform documentation
Released versions of the documentation will be published at https://www.suse.com/documentation/ once available.
If you would like to contribute, please fork this repository and send
pull requests. Always use the develop branch for your edits!
Contributors with direct access to the repository are encouraged to use the
git-flow-avh workflow (package git-flow-avh). However, this is not a must.
For help on style and structure, refer to the Documentation Styleguide
|
Note
|
No commits to master
Please do not make any commits to the master branch. master is
reserved for releases only. Always commit to develop.
|
To contribute to the documentation, you need to write DocBook.
-
You can learn about DocBook syntax at http://docbook.org/tdg5/en/html .
-
SUSE documents are generally built with DAPS (package
daps) and the SUSE XSL Stylesheets (packagesuse-xsl-stylesheets). It’s available as a SUSE rpm package from the the SUSE repository Documentation:Tools or directly from Github. -
If you are running a (recent) version of openSUSE, you can install our documentation toolchain with the following command:
sudo /sbin/OneClickInstallUI https://gitlab.nue.suse.com/susedoc/doc-ymp/raw/master/Documentation.ymp -
Basic daps usage:
-
$ daps -d DC-<YOUR_BOOK> validate: Make sure what you have written is well-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 -
Learn more at https://opensuse.github.io/daps
-