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

Documentation for built-in Zarf variables (i.e. ZARF_REGISTRY) #1374

Closed
runyontr opened this issue Feb 20, 2023 · 2 comments · Fixed by #2414
Closed

Documentation for built-in Zarf variables (i.e. ZARF_REGISTRY) #1374

runyontr opened this issue Feb 20, 2023 · 2 comments · Fixed by #2414
Labels
documentation 📘 Improvements or additions to documentation
Milestone

Comments

@runyontr
Copy link
Contributor

runyontr commented Feb 20, 2023

As Ezra I want to see what built-in templates are available so that I can use them in my own packages.

Acceptance Criteria

Given I am on docs.zarf.dev
When I visit a new page under https://docs.zarf.dev/docs/create-a-zarf-package/
Then I will see a new page discussing package defined variables and built-in deploy-time variables
And When I select that page
Then I will see sections for Variables, Constants and all of the built in templates that Zarf has.

https://github.com/defenseunicorns/zarf/blob/main/src/internal/packager/template/template.go#L75

Additional Context

I was trying to identify what zarf variables are automatically available to zarf package creators, e.g. something like ###ZARF_PKG_NAME#### or ###ZARF_PKG_NAMESPACE### but couldn't find any documentation on it.

@runyontr runyontr added the documentation 📘 Improvements or additions to documentation label Feb 20, 2023
@Racer159
Copy link
Contributor

@Madeline-UX here is another example of Docs <> Examples <> Walkthroughs information architecture mixups.

@runyontr there are some docs here: https://docs.zarf.dev/examples/package-variables/#how-to-use-create-time-package-variables

@Racer159 Racer159 changed the title Documentation around variables available to zarf packages Documentation for built-in Zarf variables (i.e. ZARF_REGISTRY) May 15, 2023
@Racer159 Racer159 added this to the The Bucket milestone Jul 3, 2023
@Noxsios
Copy link
Contributor

Noxsios commented Mar 7, 2024

My initial thoughts would be an addition to make docs-and-schema to add a go run main.go internal gen-variables-docs (or something along those lines)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📘 Improvements or additions to documentation
Projects
Status: Done
Status: Closed
Development

Successfully merging a pull request may close this issue.

3 participants