issues
search
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
80
stars
67
forks
source link
issues
Newest
Newest
Most commented
Recently updated
Oldest
Least commented
Least recently updated
"What modular documentation is" introduction uses undefined jargon making it difficult to understand
#235
emteelb
opened
3 months ago
2
Demonstrating the use of snippets for both boilerplate content and module reuse
#234
IanFrangs
opened
4 months ago
6
Define and document our team review process
#233
rolfedh
opened
4 months ago
0
Incorporate the newdoc tool into our guidance for using the templates
#232
rolfedh
opened
4 months ago
0
Update the contribution instructions
#231
rolfedh
closed
4 months ago
3
Update the contribution instructions
#230
rolfedh
closed
4 months ago
4
Fix broken links in the examples, replace some
#229
mjahoda
closed
4 months ago
0
Update What's new
#228
mjahoda
closed
4 months ago
0
WIP: Add a preview-build action for PRs
#227
mjahoda
opened
4 months ago
1
Update CONTRIBUTING.md with forking instructions
#226
rolfedh
closed
4 months ago
4
Update to the contributor instructions to fork the repo and clone the fork
#225
rolfedh
closed
4 months ago
0
Adding one line comment to procedure template
#224
Jenny-Anne
closed
4 months ago
0
Add a one-line comment to the Procedure template to avoid rendering issues
#223
Jenny-Anne
closed
4 months ago
0
Re-remove [role="_abstract"]
#222
rolfedh
closed
5 months ago
0
Re-remove [role="_abstract"]
#221
rolfedh
closed
5 months ago
0
Addressing possible design flaws in maintaining and referencing assembly-specific context IDs
#220
IanFrangs
opened
5 months ago
13
Updates regarding ID's for headings
#219
ncbaratta
opened
5 months ago
4
Fill the What's new section (retroactively, back to 2021)
#218
mjahoda
closed
6 months ago
0
Establish and document a process for maintaining the "What's new" release notes section
#217
rolfedh
opened
6 months ago
0
Add links to Short descriptions in RH SSG
#216
mjahoda
closed
6 months ago
1
Update "File names and anchors"
#215
mjahoda
closed
6 months ago
1
Add a "What's new" section to the Mod Docs standard
#214
rolfedh
closed
6 months ago
2
Error 404 for a reference module example
#213
mayurwrites
closed
4 months ago
0
Create a Vale style to check for Mod Docs rules
#212
rolfedh
opened
9 months ago
5
[WIP] Checklist
#211
rolfedh
closed
5 months ago
2
Warn before using two consecutive Additional resources
#210
mjahoda
closed
9 months ago
0
issue-203 Change :_content-type: to :_mod-docs-content-type:
#209
emmurphy1
closed
11 months ago
4
issue-200 updated modules sections and templates
#208
emmurphy1
closed
11 months ago
3
200 updated the files and reference guide to clarify Next steps, etc
#207
emmurphy1
closed
12 months ago
0
Do we have a Modular Documentation checklist?
#206
bredamc
opened
1 year ago
12
Revert "Clarify Next steps"
#205
ncbaratta
closed
1 year ago
0
Users no longer have a link to the procedure template
#204
rolfedh
closed
12 months ago
4
Fix metadata in templates from content_type to module_type
#203
ncbaratta
closed
6 months ago
23
Clarify Next steps
#202
mjahoda
closed
1 year ago
1
Remove prefixes from the IDs in the module templates
#201
mjahoda
closed
1 year ago
4
Creating modules|Procedure modules contains unclear parts
#200
mjahoda
closed
11 months ago
4
[On hold] Review and update guidance on using gerund verb form as the first word in a title of a procedure
#199
michelle-purcell
opened
1 year ago
13
Remove module prefixes from IDs in the templates
#198
mjahoda
closed
11 months ago
4
Link to the "Procedure Module Guidelines" is broken
#197
abhatt-rh
opened
1 year ago
0
Structure the "Procedure modules" section to align with its counterparts
#196
abhatt-rh
opened
1 year ago
0
Add missing links to the procedure template and procedure examples
#195
mjahoda
closed
1 year ago
2
Procedure module template link?
#194
max-cx
closed
1 year ago
1
Removing or discouraging Additional resources in assemblies
#193
mjahoda
closed
9 months ago
9
Add a guidance for assembly titles - Issue #118
#192
mjahoda
closed
1 year ago
0
Updated the _module-type variable to _content-type per Jupiter guidelines
#191
abhatt-rh
closed
1 year ago
4
issue-183-a Recreated from issue-183
#190
emmurphy1
closed
2 years ago
0
Issue 133 Headings in templates & guide should be sentence case
#189
emmurphy1
closed
2 years ago
1
issue-183 Procedure template: Refine guidance for the first step
#188
emmurphy1
closed
2 years ago
3
Issue 186: Update the snippets sections
#187
emmurphy1
closed
2 years ago
1
Update the snippets sections
#186
emmurphy1
closed
2 years ago
1
Next