Skip to content

Commit 9df5c17

Browse files
committed
issues-109-11-115 updated introduction and added note about PV2
1 parent 2782623 commit 9df5c17

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed
Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
[id="introduction"]
2-
= Introduction
1+
[id="introduction_{context}"]
2+
= Introduction to Modular Documentation
33

4-
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.
4+
This guide provides instructions on how to author modularly structured user stories. It defines terminology, describes components that form modular documentation, and provides instructions on how to use the provided modularization templates to create user stories. Most of the information included in this guide is generic. However, some instructions are required for documents that will be published on the Pantheon version 2 (V2) documentation management system. This requirement is noted where applicable.
5+
6+
Pantheon V2 is an open-source modular documentation management system being developed by Red Hat. The engineering team is building the ability to import modular content written in AsciiDoc from one or more Git repositories, assign metadata to it to enhance search-engine optimization, and publish that content to one or more targets.
7+
8+
The Pantheon community is still new but growing, and through ongoing development Red Hat aims to provide a solution that not only powers its own product documentation teams, but also offers greater flexibility to open source communities to create modular content that addresses individual use cases and can be drawn and combined from multiple sources.

modular-docs-manual/content/topics/module_anchor-and-file-names-concept.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ These file naming guidelines are optional but highly recommended. However, if yo
3636
:system-module-type: REFERENCE
3737
----
3838

39-
39+
NOTE: This is a requirement if you will publish on Pantheon V2. For more information, see xref:introduction_{context}[].
4040

4141
.Anchors
4242
At the top of every module, provide an anchor in the format `+++[id="filename_{context}"]+++` where `filename` is the exact name of the file, without the file extension (`.adoc`). Module anchors are necessary so that Asciidoctor can identify the module when the module is reused or cross-referenced. The `context` variable is defined in each assembly module, for example `:context: my-context-value`. When you build an assembly, the value of the `context` variable replaces `{context}` in each module anchor ID and appears in generated URL.

0 commit comments

Comments
 (0)