redhat-documentation / modular-docs

Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.
Creative Commons Attribution Share Alike 4.0 International
82 stars 68 forks source link

Resolves Issues 109, 111, and 115 #121

Closed emmurphy1 closed 3 years ago

emmurphy1 commented 4 years ago

Rendered HTML

Modular Documentation Review Board Notes

This update reflects recent decisions by the Modular Documentation Review Board: File names must be prefixed with proc-, con-, or ref-, or proc, con, or ref, or each module must include a module type variable. While not a requirement of Pantheon, it is good practice to include the prefix assembly- or assembly with assembly module files.

After consultation with the Pantheon engineering team, they agreed that we can change :pantheon-module-type: to :system-module-type: to make it more generic.

Anchor names should match files names without the .adoc extension, and with the addition of _{context}.

Please review these changes and post your comments or approval.

sterobin commented 4 years ago

@emmurphy1 Would you mind also updating the concrete anchor ID examples in the reusing assemblies section, just for consistency? I wrote those in parallel with the former file name guidelines, so would be ideal to update them to stay aligned.

emmurphy1 commented 4 years ago

@vikram-redhat @rkratky @oraNod @theashiot @adahms I have rewritten the introduction to include a description of Pantheon.

emmurphy1 commented 4 years ago

@redhat-documentation/fcc-review-board if you haven't done so already, please either approve or add comments to this PR. I need four more approvers to merge. Note that I have rewritten the Introduction section to include Pantheon.

emmurphy1 commented 4 years ago

@redhat-documentation/fcc-review-board I removed reference to Pantheon from this content as discussed at the last review board meeting. Pantheon-specific information will go in the Pantheon 2 User Guide. I need three more approvals to merge. Would you please review and either comment or approve if you haven't approved already? Thanks.

Preeticp commented 4 years ago

LGTM

emmurphy1 commented 3 years ago

@adahms this issue is now resolved. Please record it in the FCC Decision Register.