Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example PR to the Docs Repo #138

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
----