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

Nesting for trees entry incorrect for specification v1.2 and v1.3 #181

Closed
deuill opened this issue Dec 24, 2020 · 2 comments · Fixed by #182
Closed

Nesting for trees entry incorrect for specification v1.2 and v1.3 #181

deuill opened this issue Dec 24, 2020 · 2 comments · Fixed by #182

Comments

@deuill
Copy link

deuill commented Dec 24, 2020

Hi, I was trying to implement embedding of a file-tree via the trees directive, and was getting strange errors, e.g.:

Error translating config: yaml: unmarshal errors:
  line 3: field trees not found in type v1_3.Config

Turns out the specifications for versions 1.2 and 1.3 of FCCT have the trees field documented with incorrect nesting, i.e. they have the field as a root field, when it should be a sub-field of storage:

https://github.com/coreos/fcct/blame/master/docs/config-fcos-v1_2.md#L159
https://github.com/coreos/fcct/blame/master/docs/config-fcos-v1_3.md#L159

Seems like a natural mistake to make, as the structure of the fields is pretty hard to scan in both raw and rendered formats (both on Github and on the https://coreos.github.io/fcct) site. I wonder if a section-subsection formatting might work better?

@deuill
Copy link
Author

deuill commented Dec 24, 2020

Hm, in scanning the file again, the issue might be the indentation on the luks field above, which is one space instead of two, and which is similarly mis-rendered.

@bgilbert
Copy link
Contributor

Whoops, thanks for pointing this out! #182 should fix it.

You're right that the specs aren't super-easy to read. We have some pretty deep nesting, so I don't know if section headings are the way to go, but we could probably tweak the rendering to make the levels more distinctive. I've filed #183 for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants