diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss new file mode 100644 index 00000000..e8fa84f2 --- /dev/null +++ b/docs/_sass/custom/custom.scss @@ -0,0 +1,9 @@ +#spec-docs ~ ul { + ul { + border-left: 1px solid $grey-lt-300; + } + + li::before { + margin-left: -0.8em; + } +} diff --git a/docs/config-fcos-v1_0.md b/docs/config-fcos-v1_0.md index 2994de59..d9f8e83d 100644 --- a/docs/config-fcos-v1_0.md +++ b/docs/config-fcos-v1_0.md @@ -8,6 +8,8 @@ nav_order: 49 The Fedora CoreOS configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.0.0` and generates Ignition configs with version `3.0.0`. * **_ignition_** (object): metadata about the configuration itself. diff --git a/docs/config-fcos-v1_1.md b/docs/config-fcos-v1_1.md index f613b0a4..56a29b08 100644 --- a/docs/config-fcos-v1_1.md +++ b/docs/config-fcos-v1_1.md @@ -8,6 +8,8 @@ nav_order: 48 The Fedora CoreOS configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.1.0` and generates Ignition configs with version `3.1.0`. * **_ignition_** (object): metadata about the configuration itself. diff --git a/docs/config-fcos-v1_2.md b/docs/config-fcos-v1_2.md index 7c6fd193..bcb494f4 100644 --- a/docs/config-fcos-v1_2.md +++ b/docs/config-fcos-v1_2.md @@ -8,6 +8,8 @@ nav_order: 47 The Fedora CoreOS configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.2.0` and generates Ignition configs with version `3.2.0`. * **_ignition_** (object): metadata about the configuration itself. diff --git a/docs/config-fcos-v1_3.md b/docs/config-fcos-v1_3.md index 997dc310..5d130678 100644 --- a/docs/config-fcos-v1_3.md +++ b/docs/config-fcos-v1_3.md @@ -8,6 +8,8 @@ nav_order: 46 The Fedora CoreOS configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.3.0` and generates Ignition configs with version `3.2.0`. * **_ignition_** (object): metadata about the configuration itself. diff --git a/docs/config-fcos-v1_4.md b/docs/config-fcos-v1_4.md index 7ad549a5..607c3a9f 100644 --- a/docs/config-fcos-v1_4.md +++ b/docs/config-fcos-v1_4.md @@ -8,6 +8,8 @@ nav_order: 45 The Fedora CoreOS configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.4.0` and generates Ignition configs with version `3.3.0`. * **_ignition_** (object): metadata about the configuration itself. diff --git a/docs/config-fcos-v1_5.md b/docs/config-fcos-v1_5.md index 53a2e119..f4c1cb22 100644 --- a/docs/config-fcos-v1_5.md +++ b/docs/config-fcos-v1_5.md @@ -8,6 +8,8 @@ nav_order: 44 The Fedora CoreOS configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.5.0` and generates Ignition configs with version `3.4.0`. * **_ignition_** (object): metadata about the configuration itself. diff --git a/docs/config-fcos-v1_6-exp.md b/docs/config-fcos-v1_6-exp.md index 6ef82f7c..1179e7ba 100644 --- a/docs/config-fcos-v1_6-exp.md +++ b/docs/config-fcos-v1_6-exp.md @@ -10,6 +10,8 @@ nav_order: 50 The Fedora CoreOS configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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-experimental`. * **_ignition_** (object): metadata about the configuration itself. diff --git a/docs/config-flatcar-v1_0.md b/docs/config-flatcar-v1_0.md index 05332416..692c3920 100644 --- a/docs/config-flatcar-v1_0.md +++ b/docs/config-flatcar-v1_0.md @@ -8,6 +8,8 @@ nav_order: 99 The Flatcar configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.0.0` and generates Ignition configs with version `3.3.0`. * **_ignition_** (object): metadata about the configuration itself. diff --git a/docs/config-flatcar-v1_1.md b/docs/config-flatcar-v1_1.md index 7a03e9ba..429eb098 100644 --- a/docs/config-flatcar-v1_1.md +++ b/docs/config-flatcar-v1_1.md @@ -8,6 +8,8 @@ nav_order: 98 The Flatcar configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.1.0` and generates Ignition configs with version `3.4.0`. * **_ignition_** (object): metadata about the configuration itself. diff --git a/docs/config-flatcar-v1_2-exp.md b/docs/config-flatcar-v1_2-exp.md index 6e66be65..26a3b458 100644 --- a/docs/config-flatcar-v1_2-exp.md +++ b/docs/config-flatcar-v1_2-exp.md @@ -10,6 +10,8 @@ nav_order: 100 The Flatcar configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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-experimental`. * **_ignition_** (object): metadata about the configuration itself. diff --git a/docs/config-openshift-v4_10.md b/docs/config-openshift-v4_10.md index 47cf52df..7622710b 100644 --- a/docs/config-openshift-v4_10.md +++ b/docs/config-openshift-v4_10.md @@ -8,6 +8,8 @@ nav_order: 147 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.10.0` and generates Ignition configs with version `3.2.0`. * **metadata** (object): metadata about the generated MachineConfig resource. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config. diff --git a/docs/config-openshift-v4_11.md b/docs/config-openshift-v4_11.md index cb083efa..da683df9 100644 --- a/docs/config-openshift-v4_11.md +++ b/docs/config-openshift-v4_11.md @@ -8,6 +8,8 @@ nav_order: 146 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.11.0` and generates Ignition configs with version `3.2.0`. * **metadata** (object): metadata about the generated MachineConfig resource. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config. diff --git a/docs/config-openshift-v4_12.md b/docs/config-openshift-v4_12.md index 6d1aca99..11035711 100644 --- a/docs/config-openshift-v4_12.md +++ b/docs/config-openshift-v4_12.md @@ -8,6 +8,8 @@ nav_order: 145 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.12.0` and generates Ignition configs with version `3.2.0`. * **metadata** (object): metadata about the generated MachineConfig resource. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config. diff --git a/docs/config-openshift-v4_13.md b/docs/config-openshift-v4_13.md index f416e4ef..d87599aa 100644 --- a/docs/config-openshift-v4_13.md +++ b/docs/config-openshift-v4_13.md @@ -8,6 +8,8 @@ nav_order: 144 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.13.0` and generates Ignition configs with version `3.2.0`. * **metadata** (object): metadata about the generated MachineConfig resource. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config. diff --git a/docs/config-openshift-v4_14-exp.md b/docs/config-openshift-v4_14-exp.md index 1c9d5c73..3081aa03 100644 --- a/docs/config-openshift-v4_14-exp.md +++ b/docs/config-openshift-v4_14-exp.md @@ -10,6 +10,8 @@ nav_order: 150 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.14.0-experimental` and generates Ignition configs with version `3.5.0-experimental`. * **metadata** (object): metadata about the generated MachineConfig resource. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config. diff --git a/docs/config-openshift-v4_8.md b/docs/config-openshift-v4_8.md index 74fbf29c..a8f8fcc0 100644 --- a/docs/config-openshift-v4_8.md +++ b/docs/config-openshift-v4_8.md @@ -8,6 +8,8 @@ nav_order: 149 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.8.0` and generates Ignition configs with version `3.2.0`. * **metadata** (object): metadata about the generated MachineConfig resource. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config. diff --git a/docs/config-openshift-v4_9.md b/docs/config-openshift-v4_9.md index 6e3c5ad7..81860e5c 100644 --- a/docs/config-openshift-v4_9.md +++ b/docs/config-openshift-v4_9.md @@ -8,6 +8,8 @@ nav_order: 148 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.9.0` and generates Ignition configs with version `3.2.0`. * **metadata** (object): metadata about the generated MachineConfig resource. Respected when rendering to a MachineConfig, ignored when rendering directly to an Ignition config. diff --git a/docs/config-r4e-v1_0.md b/docs/config-r4e-v1_0.md index 720cbd0d..c295376c 100644 --- a/docs/config-r4e-v1_0.md +++ b/docs/config-r4e-v1_0.md @@ -8,6 +8,8 @@ nav_order: 199 The RHEL for Edge configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.0.0` and generates Ignition configs with version `3.3.0`. * **_ignition_** (object): metadata about the configuration itself. diff --git a/docs/config-r4e-v1_1.md b/docs/config-r4e-v1_1.md index fcd43081..5ce8126f 100644 --- a/docs/config-r4e-v1_1.md +++ b/docs/config-r4e-v1_1.md @@ -8,6 +8,8 @@ nav_order: 198 The RHEL for Edge configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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.1.0` and generates Ignition configs with version `3.4.0`. * **_ignition_** (object): metadata about the configuration itself. diff --git a/docs/config-r4e-v1_2-exp.md b/docs/config-r4e-v1_2-exp.md index 95fddfff..f9fee542 100644 --- a/docs/config-r4e-v1_2-exp.md +++ b/docs/config-r4e-v1_2-exp.md @@ -10,6 +10,8 @@ nav_order: 200 The RHEL for Edge configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional: +
+ * **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-experimental`. * **_ignition_** (object): metadata about the configuration itself. diff --git a/docs/release-notes.md b/docs/release-notes.md index 0faea9da..c3cae85a 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -20,6 +20,7 @@ nav_order: 9 ### Docs changes +- Improve rendering of spec docs on docs site ## Butane 0.18.0 (2023-03-24)