Skip to content

Commit

Permalink
Example PR to the Docs Repo
Browse files Browse the repository at this point in the history
This PR shows how to create a new page and then add it under the
System Configuration navigation heading.
  • Loading branch information
dustymabe committed Aug 7, 2020
1 parent 3fa56f7 commit ed5517a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
1 change: 1 addition & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
15 changes: 15 additions & 0 deletions modules/ROOT/pages/example.adoc
Original file line number Diff line number Diff line change
@@ -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]
----

0 comments on commit ed5517a

Please sign in to comment.