Skip to content

Commit 8ab8a64

Browse files
committed
docs: update for spec stabilization
1 parent c7031fb commit 8ab8a64

6 files changed

Lines changed: 208 additions & 8 deletions

File tree

docs/configuration-v3_6.md

Lines changed: 190 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
# This file is automatically generated from config/doc and internal/doc.
33
# Do not edit.
4-
title: Config Spec v3.6.0-experimental
4+
title: Config Spec v3.7.0-experimental
55
parent: Configuration specifications
66
nav_order: 50
77
---
88

9-
# Configuration Specification v3.6.0-experimental
9+
# Configuration Specification v3.7.0-experimental
1010

1111
_NOTE_: This pre-release version of the specification is experimental and is subject to change without notice or regard to backward compatibility.
1212

@@ -15,7 +15,7 @@ The Ignition configuration is a JSON document conforming to the following specif
1515
<div id="spec-docs"></div>
1616

1717
* **ignition** (object): metadata about the configuration itself.
18-
* **version** (string): the semantic version number of the spec. The spec version must be compatible with the latest version (`3.6.0-experimental`). Compatibility requires the major versions to match and the spec version be less than or equal to the latest version. `-experimental` versions compare less than the final version with the same number, and previous experimental versions are not accepted.
18+
* **version** (string): the semantic version number of the spec. The spec version must be compatible with the latest version (`3.7.0-experimental`). Compatibility requires the major versions to match and the spec version be less than or equal to the latest version. `-experimental` versions compare less than the final version with the same number, and previous experimental versions are not accepted.
1919
* **_config_** (object): options related to the configuration.
2020
* **_merge_** (list of objects): a list of the configs to be merged to the current config.
2121
* **source** (string): the URL of the config. Supported schemes are `http`, `https`, `tftp`, `s3`, `arn`, `gs`, and [`data`](https://tools.ietf.org/html/rfc2397). When using `http`, it is advisable to use the verification option to ensure the contents haven't been modified.

docs/migrating-configs.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@ Occasionally, there are changes made to Ignition's configuration that break back
1111
{:toc}
1212

1313

14-
## From Version 3.5.0 to 3.6.0-experimental
14+
## From Version 3.6.0 to 3.7.0-experimental
15+
16+
There are not any breaking changes between versions 3.6.0 and 3.7.0-experimental of the configuration specification. Any valid 3.6.0 configuration can be updated to a 3.7.0-experimental configuration by simply changing the version string in the config.
17+
18+
## From Version 3.5.0 to 3.6.0
1519

1620
### Special mode bits supported
1721

@@ -21,7 +25,7 @@ The `mode` field of the `files` and `directories` sections now respects the setu
2125
```json
2226
{
2327
"ignition": {
24-
"version": "3.6.0-experimental"
28+
"version": "3.6.0"
2529
},
2630
"storage": {
2731
"files": [{

docs/release-notes.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ nav_order: 9
1010

1111
### Features
1212

13+
- Mark the 3.6.0 config spec as stable
14+
- No longer accept configs with version 3.6.0-experimental
15+
- Create new 3.7.0-experimental config spec from 3.6.0
16+
1317
### Changes
1418

1519
### Bug fixes

docs/specs.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ We recommend that you always use the latest **stable** specification to benefit
1919
from new features and bug fixes. The following **stable** specification
2020
versions are currently supported in Ignition:
2121

22+
- [v3.6.0](configuration-v3_6.md)
2223
- [v3.5.0](configuration-v3_5.md)
2324
- [v3.4.0](configuration-v3_4.md)
2425
- [v3.3.0](configuration-v3_3.md)
@@ -33,7 +34,7 @@ and testing** as it is subject to change **without warning or announcement**.
3334
The following **experimental** specification version is currently available in
3435
Ignition:
3536

36-
- [v3.6.0-experimental](configuration-v3_6_experimental.md)
37+
- [v3.7.0-experimental](configuration-v3_7_experimental.md)
3738

3839
## Legacy spec 2.x configuration specifications
3940

@@ -55,4 +56,5 @@ recommended to use the latest Ignition release.
5556
| 3.2.0 | 2.7.0 |
5657
| 3.3.0 | 2.11.0 |
5758
| 3.4.0 | 2.15.0 |
58-
| 3.5.0 | 2.20.0 |
59+
| 3.5.0 | 2.20.0 |
60+
| 3.6.0 | 2.26.0 |

generate

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ hash schematyper 2>/dev/null || {
1212
exit 1
1313
}
1414

15-
specs="v3_0 v3_1 v3_2 v3_3 v3_4 v3_5 v3_6_experimental"
15+
specs="v3_0 v3_1 v3_2 v3_3 v3_4 v3_5 v3_6 v3_7_experimental"
1616

1717
for spec in $specs
1818
do

0 commit comments

Comments
 (0)