redhat-documentation/modular-docs

Issues

• "What modular documentation is" introduction uses undefined jargon making it difficult to understand

  #235 opened 7 months ago by emteelb
  2

• Demonstrating the use of snippets for both boilerplate content and module reuse

  #234 opened 8 months ago by IanFrangs
  6

• Updates regarding ID's for headings

  #219 opened 10 months ago by ncbaratta
  4

• Add a one-line comment to the Procedure template to avoid rendering issues

  #223 opened 8 months ago by Jenny-Anne
  0

• Error 404 for a reference module example

  #213 opened 8 months ago by mayurwrites
  0

• Update to the contributor instructions to fork the repo and clone the fork

  #225 opened 8 months ago by rolfedh
  0

• add functional xrefs to templates

  #171 opened 8 months ago by ryandeussing
  3

• Define and document our team review process

  #233 opened 8 months ago by rolfedh
  0

• Incorporate the newdoc tool into our guidance for using the templates

  #232 opened 8 months ago by rolfedh
  0

• Addressing possible design flaws in maintaining and referencing assembly-specific context IDs

  #220 opened 10 months ago by IanFrangs
  13

• Re-remove [role="_abstract"]

  #221 opened 9 months ago by rolfedh
  0

• Fix metadata in templates from content_type to module_type

  #203 opened 10 months ago by ncbaratta
  23

• Establish and document a process for maintaining the "What's new" release notes section

  #217 opened 10 months ago by rolfedh
  0

• Do we have a Modular Documentation checklist?

  #206 opened a year ago by bredamc
  12

• Create a Vale style to check for Mod Docs rules

  #212 opened a year ago by rolfedh
  5

• Removing or discouraging Additional resources in assemblies

  #193 opened a year ago by mjahoda
  9

• Add guidance for writing abstracts

  #170 opened a year ago by rolfedh
  16

• Remove module prefixes from IDs in the templates

  #198 opened a year ago by mjahoda
  4

• Creating modules|Procedure modules contains unclear parts

  #200 opened a year ago by mjahoda
  4

• Users no longer have a link to the procedure template

  #204 opened a year ago by rolfedh
  4

• [On hold] Review and update guidance on using gerund verb form as the first word in a title of a procedure

  #199 opened 2 years ago by michelle-purcell
  13

• Explore ways to document troubleshooting steps

  #169 opened 3 years ago by emmurphy1
  7

• Procedure module template link?

  #194 opened 2 years ago by max-cx
  1

• s/master/main

  #173 opened 2 years ago by oraNod
  1

• Structure the "Procedure modules" section to align with its counterparts

  #196 opened 2 years ago by abhatt-rh
  0

• Link to the "Procedure Module Guidelines" is broken

  #197 opened 2 years ago by abhatt-rh
  0

• Add image with title and alt text to concept module

  #172 opened 2 years ago by oraNod
  2

• Procedure template: Refine guidance for the first step

  #183 opened 3 years ago by jenmalloy
  4

• Can we remove [role="_abstract"] from the templates?

  #184 opened 3 years ago by emmurphy1
  3

• Update the snippets sections

  #186 opened 3 years ago by emmurphy1
  1

• Headings in templates & guide should be sentence case

  #133 opened 3 years ago by ncbaratta
  2

• Start versioning the templates

  #152 opened 3 years ago by Levi-Leah
  4

• Add an assembly attribute option

  #175 opened 3 years ago by kalexand-rh
  9

• Recommend spacing out includes

  #165 opened 3 years ago by jherrman
  10

• Provide guidance on creating sub-assemblies or modules instead of second level headings

  #129 opened 4 years ago by Preeticp
  3

• Add [] to the snippet example file.

  #179 opened 3 years ago by emmurphy1
  2

• Clarify the use of a default value for the context variable in modules

  #167 opened 3 years ago by vikram-redhat
  3

• Add CODEOWNERS file

  #141 opened 3 years ago by rkratky
  0

• Inconsistent module IDs in the procedure module template

  #155 opened 3 years ago by yetanothertw
  5

• Clarify rules for text following [role="_abstract"] in the templates

  #160 opened 3 years ago by stoobie
  2

• Change format of Additional Resources/Next Steps to bulleted links only in the templates

  #135 opened 3 years ago by emmurphy1
  6

• Clarify that the "Prerequisites" heading is always plural

  #153 opened 3 years ago by bergerhoffer
  5

• Include :_module-type: variable into the template

  #151 opened 3 years ago by Levi-Leah
  25

• Pantheon 2 creates its own labels for "Additional resources" in modules vs assemblies. That should be dealt with here.

  #158 opened 4 years ago by stoobie
  3

• Remove "// Module included in the following assemblies section"?

  #149 opened 4 years ago by rolfedh
  13

• Provide templates for required master.adoc, attributes.adoc, and master-docinfo.xml files for PV1 and PV2

  #146 opened 4 years ago by spank50
  1

• Revert "Verification steps" back to "Verification"

  #147 opened 4 years ago by jherrman
  11

• Clarification required regarding numbered lists

  #138 opened 4 years ago by bobjohnsrh
  4

• Update examples in Appendix B

  #128 opened 4 years ago by emmurphy1
  3

• Clarify use of sub-headings in concepts and references

  #137 opened 4 years ago by sterobin
  4