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
bgilbert committed Feb 2, 2021
1 parent c7a8fe6 commit 40b210a
Show file tree
Hide file tree
Showing 2 changed files with 28 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 @@ -32,6 +32,7 @@
*** xref:sysconfig-configure-wireguard.adoc[Configuring WireGuard]
*** xref:kernel-args.adoc[Modifying Kernel Arguments]
*** xref:alternatives.adoc[Setting alternatives]
*** xref:example.adoc[Example Docs PR]
** OS updates
*** xref:update-streams.adoc[Update Streams]
*** xref:auto-updates.adoc[Auto-Updates]
Expand Down
27 changes: 27 additions & 0 deletions modules/ROOT/pages/example.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
= 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 `System Configuration`.
[source]
----
** System Configuration
*** xref:example.adoc[Example Docs PR]
----

- Here's how to embed a Fedora CoreOS Config in the docs. If this template is followed, FCCs will be automatically validated by CI.
[source,yaml]
----
variant: fcos
version: 1.3.0
storage:
files:
- path: /etc/example
contents:
inline: |
Hello world.
----

0 comments on commit 40b210a

Please sign in to comment.