Skip to content

Commit ed5517a

Browse files
committed
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.
1 parent 3fa56f7 commit ed5517a

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
*** xref:sysctl.adoc[Kernel Tuning]
2323
*** xref:running-containers.adoc[Running Containers]
2424
*** xref:authentication.adoc[Configuring Authentication]
25+
*** xref:example.adoc[Example Docs PR]
2526
** OS updates
2627
*** xref:update-streams.adoc[Update Streams]
2728
*** xref:auto-updates.adoc[Auto-Updates]

modules/ROOT/pages/example.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:experimental:
2+
= Example PR to Docs repo
3+
4+
5+
- Create a page under `modules/ROOT/pages/`
6+
7+
Give the file a name like `example.adoc`. Fill in the contents.
8+
9+
- Add an entry in the navigation file (`modules/ROOT/nav.adoc`) under under `System Configuration`.
10+
11+
[source]
12+
----
13+
** System Configuration
14+
*** xref:example.adoc[Example Docs PR]
15+
----

0 commit comments

Comments
 (0)