Example PR to the Docs Repo

This PR shows how to create a new page and then add it under the System Configuration navigation heading.
coreos · Aug 7, 2020 · ed5517a · ed5517a
1 parent 3fa56f7
commit ed5517a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc
@@ -22,6 +22,7 @@
 *** xref:sysctl.adoc[Kernel Tuning]
 *** xref:running-containers.adoc[Running Containers]
 *** xref:authentication.adoc[Configuring Authentication]
+*** xref:example.adoc[Example Docs PR]
 ** OS updates
 *** xref:update-streams.adoc[Update Streams]
 *** xref:auto-updates.adoc[Auto-Updates]

diff --git a/modules/ROOT/pages/example.adoc b/modules/ROOT/pages/example.adoc
@@ -0,0 +1,15 @@
+:experimental:
+= Example PR to Docs repo
+
+
+- Create a page under `modules/ROOT/pages/`
+
+Give the file a name like `example.adoc`. Fill in the contents.
+
+- Add an entry in the navigation file (`modules/ROOT/nav.adoc`) under under `System Configuration`.
+
+[source]
+----
+** System Configuration                                        
+*** xref:example.adoc[Example Docs PR]
+----