Open gmarpons opened 4 years ago
Admin manual (its version should evolve with the software)
Until we have v1.0, we're not supporting old versions, as we're preferring to move fast vs maintaining compatibility/supporting past releases. When we have the v1.0 then I think this would be great!
Developer's documentation (same as above)
Idem
Whitepaper (It makes sense to distribute it independently, as a PDF, etc)
It could be, but I'd prefer to apply YAGNI here, as at the moment (and for the last 2 years) we only have 1 section of the Whitepaper published, so, if/when there's this need we could apply this.
There are more sections of the Whitepaper that could be converted to AsciiDoc and published, see #17.
I think that antora.yml files are a good way to store metadata about documents (authors, etc). But I agree its not a priority right now and it's easy to convert any module into a component at any moment. We can wait until we have a stable site with all the information we want and we have time to tailor the UI to show that metadata.
An Antora component can have:
Examples of Metadata:
This doesn't mean to move this parts of the documentation to another repo, only add antora.yml files in some subdirs, and add a line to the playbook.yml.
For me, candidates to be components would be: