diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index dc3373db..a472af81 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -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] diff --git a/modules/ROOT/pages/example.adoc b/modules/ROOT/pages/example.adoc new file mode 100644 index 00000000..441af06e --- /dev/null +++ b/modules/ROOT/pages/example.adoc @@ -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. +----