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 Steps zz spacewalk docs.conf
Joseph Cayouette edited this page May 24, 2019
·
1 revision
We have to make three simple changes to our apache config when publishing product WebUI documentation. This can be done directly on OBS(IBS)
File zz-spacewalk-docs.conf in Package susemanager-docs_en
RewriteEngine on
RewriteOptions inherit
<Directory "/srv/www/htdocs/docs">
# Prepend "/product/version/" to the paths, if the original path is not available
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
# Rewrite only if the prepended path is available
RewriteCond %{DOCUMENT_ROOT}/docs/suse-manager/beta3/$1 -f [OR]
RewriteCond %{DOCUMENT_ROOT}/docs/suse-manager/beta3/$1 -d
RewriteRule ^(.*)$ /docs/suse-manager/beta3/$1 [R]
</Directory>
Adjust the branch name to match whatever release you are publishing for. In the above example code you would change beta3.
After 4.0 release we will look into automating this.
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