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

docs: clarify detail about which global flags may be declared in config file #1833

Closed
timblaktu opened this issue Jun 20, 2023 · 0 comments · Fixed by #1843
Closed

docs: clarify detail about which global flags may be declared in config file #1833

timblaktu opened this issue Jun 20, 2023 · 0 comments · Fixed by #1843
Assignees
Labels
documentation 📘 Improvements or additions to documentation

Comments

@timblaktu
Copy link

This issue is a follow-up on this conversation in defenseunicorns/uds-package-dubbd#279 about a minor inconsistency in the documentation about which CLI args can be declared in a zarf config file. In response to this footnote:

@Racer159 said:

This isn't entirely true - sub items (like package.create.output_directory) can be configured too, but --confirm is explicitly excluded to encourage interactive deployments and reviews of packages (if it were hidden in a zarf-config file less experienced users may not get the option to review a deployment to see if they are deploying (or removing!) the correct package.

I believe this page needs to be changed from this:

Users can configure the zarf init, zarf package create, zarf package deploy command flags, as well as any global flags, through a config file.

to this:

Users can configure the zarf init, zarf package create, zarf package deploy command flags, as well as most1 global flags, through a config file.

Footnotes

  1. Noting that only global zarf options may be declared, and that --confirm is not a global option.

@timblaktu timblaktu added the documentation 📘 Improvements or additions to documentation label Jun 20, 2023
@timblaktu timblaktu self-assigned this Jun 20, 2023
Racer159 added a commit that referenced this issue Jun 23, 2023
Racer159 added a commit that referenced this issue Jun 23, 2023
## Description

Fixes an issue where the component import examples weren't showing in
the components page.

## Related Issue

Fixes #1831 
Fixes #1833 
Fixes #1796

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed
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
None yet
Development

Successfully merging a pull request may close this issue.

1 participant