From 40b210aa8622b6c7caa4283d4ac8057966d00943 Mon Sep 17 00:00:00 2001
From: Benjamin Gilbert <bgilbert@redhat.com>
Date: Tue, 2 Feb 2021 09:33:05 -0500
Subject: [PATCH] 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.
---
 modules/ROOT/nav.adoc           |  1 +
 modules/ROOT/pages/example.adoc | 27 +++++++++++++++++++++++++++
 2 files changed, 28 insertions(+)
 create mode 100644 modules/ROOT/pages/example.adoc

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.
+----