This repository has been archived by the owner on Apr 12, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 34
Publishing API Documentation Online
Joseph Cayouette edited this page Nov 23, 2017
·
14 revisions
##Updating SUSE Manager API Documentation and Posting Online##
SUSE Manager 3 (SLE 12 SP1 example):
# rename existing directory
old binaries
# checkout the official binary packages
# The following getbinaries command is for SUSE Manager 3.0
iosc getbinaries SUSE:SLE-12-SP1:Update:Products spacewalk-java standard x86_64
# SUSE Manager 3.1 is based on SLES12-SP2
You can get the package directly from the correct repository.
http://download.suse.de/ibs/SUSE:/SLE-12-SP2:/Update:/Products:/Manager31:/Update/standard/noarch/
# get the docbook file
unrpm binaries/spacewalk-java-apidoc-sources*
# ==>
# usr/share/doc/packages/spacewalk-java/xml/susemanager_api_doc.xml
# build the PDF with daps:
daps -m usr/share/doc/packages/spacewalk-java/xml/susemanager_api_doc.xml pdf
Then create a bug (Classification: Doc Tools, Product: Doc Production, Component: SUSE Manager) and ask to update suse.com/documentation/suse-manager-3 accordingly. As an example, see https://bugzilla.suse.com/show_bug.cgi?id=976225 .
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