talos
talos copied to clipboard
siderolabs
docs: update go structs with updated format for docgen
this would break machine config comments, JSON schema generation, etc.
it doesn't cover new machine config documents either
- Config comments: They tend to be more confusing for users than helpful. I think we can solve our intention there with something else.
- JSON schema generation: this is still generated with https://github.com/siderolabs/documentation/tree/main/gen for the code and https://github.com/siderolabs/documentation/blob/main/ui/src/pages/docs/schema.json is the output. I can get it it published in the docs like it is now. Does it need to be in the Talos repo?
- Hmm I could have sworn I grabbed them in the merge. What is missing?
I think this need to be planned properly with exact ideas on what is going to be dropped, moved, removed, etc.
Can we do it with more transitional changes and less breaking changes?
How it's going to look in the end and so on. So far it won't pass the CI even.
I think this need to be planned properly with exact ideas on what is going to be dropped, moved, removed, etc.
Can we do it with more transitional changes and less breaking changes?
How it's going to look in the end and so on. So far it won't pass the CI even.
This is a draft so I don't expect it to pass just yet. I posted in our private Slack I would like to discuss this week. This is just here in the form it is now to help illustrate the changes so we can have a more meaningful discussion.
Picking this back up finally. Not ready for review yet but I want to use CI for testing. I plan on basing other PRs off of this one and going through a series of PRs that we can get aligned and push through.