Skip to content

Commit 40b210a

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 c7a8fe6 commit 40b210a

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
*** xref:sysconfig-configure-wireguard.adoc[Configuring WireGuard]
3333
*** xref:kernel-args.adoc[Modifying Kernel Arguments]
3434
*** xref:alternatives.adoc[Setting alternatives]
35+
*** xref:example.adoc[Example Docs PR]
3536
** OS updates
3637
*** xref:update-streams.adoc[Update Streams]
3738
*** xref:auto-updates.adoc[Auto-Updates]

modules/ROOT/pages/example.adoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
= Example PR to Docs repo
2+
3+
- Create a page under `modules/ROOT/pages/`
4+
5+
Give the file a name like `example.adoc`. Fill in the contents.
6+
7+
- Add an entry in the navigation file (`modules/ROOT/nav.adoc`) under `System Configuration`.
8+
9+
[source]
10+
----
11+
** System Configuration
12+
*** xref:example.adoc[Example Docs PR]
13+
----
14+
15+
- Here's how to embed a Fedora CoreOS Config in the docs. If this template is followed, FCCs will be automatically validated by CI.
16+
17+
[source,yaml]
18+
----
19+
variant: fcos
20+
version: 1.3.0
21+
storage:
22+
files:
23+
- path: /etc/example
24+
contents:
25+
inline: |
26+
Hello world.
27+
----

0 commit comments

Comments
 (0)