Skip to content
This repository has been archived by the owner on Feb 2, 2023. It is now read-only.

Docs on Zarf config schema #32

Closed
RothAndrew opened this issue Jul 5, 2022 · 3 comments
Closed

Docs on Zarf config schema #32

RothAndrew opened this issue Jul 5, 2022 · 3 comments

Comments

@RothAndrew
Copy link
Member

We need docs on the zarf config schema. See this issue for an example of why it is important.

Here's an example of what it could potentially look like from the Flux docs: https://fluxcd.io/docs/components/helm/api/

Hopefully there is a way to automatically generate the documentation based on the golang code.

@RothAndrew
Copy link
Member Author

Just found this page: https://docs.zarf.dev/docs/user-guide/zarf-packages/zarf-components#what-makes-up-a-component

Looks like it is manually written though, which will make it hard to keep up to date.

Looks like it is also missing the schema doc for the rest of the config file

@Racer159
Copy link
Contributor

Racer159 commented Jul 20, 2022

Does this answer this issue @RothAndrew ? https://docs.zarf.dev/docs/user-guide/zarf-schema (what makes a component just links there)

@RothAndrew
Copy link
Member Author

Yes. Thanks :)

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

No branches or pull requests

2 participants