Back in 2019 Red Hat open sourced its Satellite documentation. This talk will answer where it’s today, how it got there and where it can go. All from multiple perspectives, such as end user, (technical) writer and developer.
5. A history lesson
●
theforeman.org/manuals created in 2012
– Shortly after Foreman 1.0
●
theforeman.org/plugins created in 2015
●
docs.theforeman.org created in 2019
– Based on Satellite documentation
– Credits to Lukaš Zapletal and Melanie Corr
6. Foreman Manual & Plugins
●
github.com/theforeman/theforeman.org
●
Part of the website, using Jekyll
●
Foreman links to it
●
Large manual + quickstart guide & various plugins
●
/latest and /nightly symlinks using Puppet
●
Branching is painful
11. Status
●
Primary source for Katello
●
Experimental for Foreman
– All guides hidden on release branches
●
Upstream
– Red Hat Satellite
– ATIX Orcharhino
12.
13.
14. asciidoc
●
Attributes - like variables
●
Macros & conditionals
●
Easy reuse with includes
●
docs.asciidoctor.org/asciidoc/latest
15.
16. Multiple guides
●
Directory with guides
●
Common
– Attributes
– Assemblies
– Modules
●
github.com/redhat-documentation/modular-docs
26. How to get there?
●
Deal with Katelloisms
●
Debian documentation
●
Map all existing documentation
●
Enhance Foreman documentation buttons
●
Update all plugins
●
(Update Red Hat branding mapping)
27. Guides
●
Review existing
●
Further utilize capability of multiple guides
●
Add new guides
– DNS integration guide
– DHCP integration guide
●
Improve landing page
●
Antora?