Skip to content

Commit

Permalink
docs/main: add new fcos/v1_7_exp spec to doc generation, and run it
Browse files Browse the repository at this point in the history
  • Loading branch information
prestist committed Nov 26, 2024
1 parent 95936d1 commit 326623b
Show file tree
Hide file tree
Showing 7 changed files with 240 additions and 9 deletions.
229 changes: 229 additions & 0 deletions docs/config-fcos-v1_6.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/config-fcos-v1_6-exp.md → docs/config-fcos-v1_7-exp.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
# This file is automatically generated from internal/doc and Ignition's
# config/doc. Do not edit.
title: Fedora CoreOS v1.6.0-experimental
title: Fedora CoreOS v1.7.0-experimental
parent: Configuration specifications
nav_order: 50
---

# Fedora CoreOS Specification v1.6.0-experimental
# Fedora CoreOS Specification v1.7.0-experimental

**Note: This configuration is experimental and has not been stabilized. It is subject to change without warning or announcement.**

Expand All @@ -15,7 +15,7 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
<div id="spec-docs"></div>

* **variant** (string): used to differentiate configs for different operating systems. Must be `fcos` for this specification.
* **version** (string): the semantic version of the spec for this document. This document is for version `1.6.0-experimental` and generates Ignition configs with version `3.5.0`.
* **version** (string): the semantic version of the spec for this document. This document is for version `1.7.0-experimental` and generates Ignition configs with version `3.6.0-experimental`.
* **_ignition_** (object): metadata about the configuration itself.
* **_config_** (object): options related to the configuration.
* **_merge_** (list of objects): a list of the configs to be merged to the current config.
Expand Down
2 changes: 1 addition & 1 deletion docs/config-fiot-v1_1-exp.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Fedora IoT configuration is a YAML document conforming to the following spec
<div id="spec-docs"></div>

* **variant** (string): used to differentiate configs for different operating systems. Must be `%VARIANT%` for this specification.
* **version** (string): the semantic version of the spec for this document. This document is for version `%VERSION%` and generates Ignition configs with version `3.5.0`.
* **version** (string): the semantic version of the spec for this document. This document is for version `%VERSION%` and generates Ignition configs with version `3.6.0-experimental`.
* **_ignition_** (object): metadata about the configuration itself.
* **_config_** (object): options related to the configuration.
* **_merge_** (list of objects): a list of the configs to be merged to the current config.
Expand Down
2 changes: 1 addition & 1 deletion docs/config-flatcar-v1_2-exp.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Flatcar configuration is a YAML document conforming to the following specifi
<div id="spec-docs"></div>

* **variant** (string): used to differentiate configs for different operating systems. Must be `flatcar` for this specification.
* **version** (string): the semantic version of the spec for this document. This document is for version `1.2.0-experimental` and generates Ignition configs with version `3.5.0`.
* **version** (string): the semantic version of the spec for this document. This document is for version `1.2.0-experimental` and generates Ignition configs with version `3.6.0-experimental`.
* **_ignition_** (object): metadata about the configuration itself.
* **_config_** (object): options related to the configuration.
* **_merge_** (list of objects): a list of the configs to be merged to the current config.
Expand Down
2 changes: 1 addition & 1 deletion docs/config-openshift-v4_18-exp.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The OpenShift configuration is a YAML document conforming to the following speci
<div id="spec-docs"></div>

* **variant** (string): used to differentiate configs for different operating systems. Must be `openshift` for this specification.
* **version** (string): the semantic version of the spec for this document. This document is for version `4.18.0-experimental` and generates Ignition configs with version `3.5.0`.
* **version** (string): the semantic version of the spec for this document. This document is for version `4.18.0-experimental` and generates Ignition configs with version `3.6.0-experimental`.
* **metadata** (object): metadata about the generated MachineConfig resource. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config.
* **name** (string): a unique [name](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names) for this MachineConfig resource.
* **labels** (object): string key/value pairs to apply as [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to this MachineConfig resource. `machineconfiguration.openshift.io/role` is required.
Expand Down
2 changes: 1 addition & 1 deletion docs/config-r4e-v1_2-exp.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The RHEL for Edge configuration is a YAML document conforming to the following s
<div id="spec-docs"></div>

* **variant** (string): used to differentiate configs for different operating systems. Must be `r4e` for this specification.
* **version** (string): the semantic version of the spec for this document. This document is for version `1.2.0-experimental` and generates Ignition configs with version `3.5.0`.
* **version** (string): the semantic version of the spec for this document. This document is for version `1.2.0-experimental` and generates Ignition configs with version `3.6.0-experimental`.
* **_ignition_** (object): metadata about the configuration itself.
* **_config_** (object): options related to the configuration.
* **_merge_** (list of objects): a list of the configs to be merged to the current config.
Expand Down
6 changes: 4 additions & 2 deletions internal/doc/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ import (
fcos1_3 "github.com/coreos/butane/config/fcos/v1_3"
fcos1_4 "github.com/coreos/butane/config/fcos/v1_4"
fcos1_5 "github.com/coreos/butane/config/fcos/v1_5"
fcos1_6_exp "github.com/coreos/butane/config/fcos/v1_6_exp"
fcos1_6 "github.com/coreos/butane/config/fcos/v1_6"
fcos1_7_exp "github.com/coreos/butane/config/fcos/v1_7_exp"
fiot1_0 "github.com/coreos/butane/config/fiot/v1_0"
fiot1_1_exp "github.com/coreos/butane/config/fiot/v1_1_exp"
flatcar1_0 "github.com/coreos/butane/config/flatcar/v1_0"
Expand Down Expand Up @@ -102,13 +103,14 @@ func generate(dir string) error {
"fcos",
[]version{
// inverse order of website navbar
{"1.6.0-experimental", fcos1_6_exp.Config{}},
{"1.7.0-experimental", fcos1_7_exp.Config{}},
{"1.0.0", fcos1_0.Config{}},
{"1.1.0", fcos1_1.Config{}},
{"1.2.0", fcos1_2.Config{}},
{"1.3.0", fcos1_3.Config{}},
{"1.4.0", fcos1_4.Config{}},
{"1.5.0", fcos1_5.Config{}},
{"1.6.0", fcos1_6.Config{}},
},
},
{
Expand Down

0 comments on commit 326623b

Please sign in to comment.