-
Notifications
You must be signed in to change notification settings - Fork 34
Online Documentation Update
ATM (2019-02-14), the daps
online-docs command does not work for version 3.2. Use the container solution to build all wanted targets manually.
A procedure like the following works for version 3.1 and earlier.
ATM (2016-07-13), you must use a recent daps
checkout from
git@github.com:openSUSE/daps.git
.
Switch to the directory of the documentation checkout and enter:
.../daps/bin/daps --dapsroot .../daps -d DC-create-all online-docs
Repeat it for all the pdfsub
packages listed in DEF-susemanager-docs
:
.../daps/bin/daps --dapsroot .../daps -d DC-DC-susemanager-getting-started online-docs
.../daps/bin/daps --dapsroot .../daps -d DC-DC-susemanager-reference online-docs
.../daps/bin/daps --dapsroot .../daps -d DC-DC-susemanager-best-practices online-docs
.../daps/bin/daps --dapsroot .../daps -d DC-DC-susemanager-advanced-topics online-docs
Copy the results to the results to your ~/Exports
directory.
mkdir ~/Export/susemanager-3
cp -va build/{create-all,susemanager-advanced-topics,\
susemanager-best-practices,susemanager-reference,\
susemanager-getting-started}/online-docs/* ~/Export/susemanager-3
Create a bug (Classification: Doc Tools, Product: Doc Production, Component: SUSE Manager) and ask to update http://www.suse.com/documentation/suse-manager-3 accordingly. As an example, see bug 975925 or bug 981142.
Each time we publish remember to ask for all sources to be placed on .com PDF, single-html, epub, and html
Setup and Build
- Setup rbenv and Ruby
- Install nvm
- Install Antora
- Install Asciidoctor Gems
- Building the Docs
- Optional Tools
How to Publish
Publish to OBS
Publish Enterprise Docs
Publishing to Github Pages
Want to Help?
Get Started with Asciidoc
Quick Syntax Reference
Asciidoctor Writer's Guide
Asciidoctor User's Manual
Resources
YAML Documentation