1
0
mirror of https://github.com/coreos/ignition.git synced 2026-02-06 18:47:54 +01:00
Commit Graph

12 Commits

Author SHA1 Message Date
Madhu Pillai
df18924263 docs: update for spec stablization 2024-10-14 15:35:03 +02:00
Benjamin Gilbert
93cd2de9e6 generate: simplify build of doc generator 2023-04-11 17:37:36 -04:00
Benjamin Gilbert
1989f24491 Initial support for automatic spec doc generation
Move all field descriptions to a single YAML file and generate version-
specific spec docs from that.  Use reflection to walk the config
structs for each version and omit fields which don't exist in a
particular spec version.

We don't do this at a JSON Schema level because e.g. Resource is
referenced in multiple places with different semantics and different
doc strings.

For now, keep the code out of the external API.  The plan is to add
functionality to support Butane docs generation, at which point
internal/doc/generate will move to config/doc.

Update the stabilization checklist to remove manual tweaking of
spec docs.
2023-03-27 19:26:00 -04:00
Benjamin Gilbert
7cff68f8b3 config/v3_5_experimental: adapt for new experimental spec 2023-02-20 03:09:50 -05:00
Jonathan Lebon
4410f5ecf5 config/v3_4_experimental: adapt for experimental 2021-06-24 10:24:02 -04:00
Stephen Lowrie
7c2bb46041 config/v3_3_experimental: create new experimental package 2020-09-28 23:32:07 -05:00
Benjamin Gilbert
469a5cc738 config/v3_2_experimental: set up package
Following instructions in development.md.
2020-05-03 01:42:20 -04:00
Andrew Jeddeloh
1d34cf6d6b config: add v3.1.0-experimental spec 2019-04-04 15:13:20 -07:00
Andrew Jeddeloh
ca84f7ee8e *: stablize spec 3.0.0
Make 3.0.0-experimental into 3.0.0.
2019-03-25 14:38:23 -07:00
Andrew Jeddeloh
0764326968 config: move json schema to be with its types
Lets move the json schema file to the config/$ver/ directory and keep
the source for each spec version with its generated types.
2019-03-15 14:24:16 -07:00
Derek Gonyeo
7e4fd35aa1 generate: write to internal/config/types, copy output to latest exp
There should now be two copies of the golang latest schema,
internal/config/types/schema.go and
config/vX_Y_experimental/types/schema.go. Modify the generate script to
create internal/config/types/schema.go and then copy it to the
experimental config package.
2018-03-08 16:03:11 -08:00
Derek Gonyeo
6584df3d4a added generate script and json-schema spec
Adds a json file defining the schema for an ignition config using
json-schema, and a generate script that uses schematyper to convert it
into golang structs inside the ignition codebase.
2017-04-11 16:54:49 +02:00