Skip to content

Commit 197b298

Browse files
sterobinRobert Krátký
andauthored
Resolves issue #114: Update mod doc repo example and instructions (#120)
* Update mod repo example. * Add missing components to enable pantheon build of mod guide. * Fix p2 yaml. * Initial review edits. * Update wording in symlink bullet Co-authored-by: Robert Krátký <[email protected]> * Update mod doc repo content to redirect to separate branch for details. * Clean up html and add to gitignore. * Delete master.html * Update mod intro Co-authored-by: Robert Krátký <[email protected]> * Update mod intro2 Co-authored-by: Robert Krátký <[email protected]> * Remove master-docinfo to disable ccutil building. Co-authored-by: Robert Krátký <[email protected]>
1 parent c6865c6 commit 197b298

8 files changed

+12
-33
lines changed

modular-docs-manual/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
build
2+
master.html

modular-docs-manual/content/modular-doc-manual.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,3 @@ include::topics/mod-docs-examples.adoc[leveloffset=+1]
1616

1717
[appendix]
1818
include::topics/mod-docs-conversion.adoc[leveloffset=+1]
19-

modular-docs-manual/content/topics/introduction.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@
22
= Introduction
33

44
This manual provides instructions on how to author modularly structured documentation based on user stories. The manual defines used terminology, describes components that form modular documentation, and instructs writers on how to use provided templates to turn user stories into modular documentation.
5+
6+
IMPORTANT: As modular documentation imperatives continue to evolve, the details and recommendations in this guide might be modified.

modular-docs-manual/content/topics/module_a-simple-example-of-a-modular-guide.adoc

Lines changed: 0 additions & 31 deletions
This file was deleted.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[id="modular-documentation-repositories"]
2+
= Modular Documentation Repositories
3+
4+
Due to many factors that determine repository design for individual products, these modular documentation guidelines do not provide a strict documentation repository template.
5+
6+
For a general repository structure used by documentation teams at Red Hat, see the example documentation repository and `README` file in the https://github.com/redhat-documentation/modular-docs/tree/mod-doc-repo-example[`mod-doc-repo-example`] branch in this repository.

modular-docs-manual/content/topics/understanding-mod-docs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ include::module_what-modular-documentation-is.adoc[leveloffset=+1]
77

88
include::module_what-modular-documentation-is-not.adoc[leveloffset=+1]
99

10-
include::module_a-simple-example-of-a-modular-guide.adoc[leveloffset=+1]
10+
include::module_modular-documentation-repositories.adoc[leveloffset=+1]

modular-docs-manual/content/topics/writing-mod-docs.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[id="writing-mod-docs"]
22
= Writing Modular Documentation
3+
:context: writing-mod-docs
34

45
Assemblies can include various types of modules. Use the instructions in the following sections to create modules and combine them into assemblies.
56

Binary file not shown.

0 commit comments

Comments
 (0)