Modularizing the distribution of files #27
Conversation
|
NB: The |
…in che-docs * Running `gulp` also generates the API reference. * Name the Antora module _user-guide_ (don't keep default name _ROOT_). * `antora-playbook.yml`: add edit button, delete old builds, indexify, define AsciiDoc attributes. * `antora.yml`: contains all metadata. * Antora `pages` directory contain only metadata and include statement. * Antora `partials` and `examples` directories contains _Modular Documentation_ topic files: `assembly_*`, `con_*`, `proc_*`, `ref_*`. * Antora `nav.adoc` uses the pages attributes for titles. * Compliance of Modular Documentation topics metadata and structure (partials and examples). * Complete `supplemental-ui` with items borrowed from che-docs.
|
This is a preview of the reworked outline:
|
|
@mmulholl the description in this PR describes most of the good practices I could think of while preparing it. Please ping me for anything left unclear and for a detailed explanation. |
|
/approve |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: mmulholla, rkratky, themr0c The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Pushing the project in the same direction as che-docs.
gulpalso generates the API reference.antora-playbook.yml: add edit button, delete old builds, indexify, define AsciiDoc attributes.antora.yml: contains all metadata.pagesdirectory contain only metadata and include statement.partialsandexamplesdirectories contains Modular Documentation topic files:assembly_*,con_*,proc_*,ref_*.nav.adocuses the pages attributes for titles.supplemental-uiwith items borrowed from che-docs.