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.

Sign up for GitHub

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

Jump to bottom

1216 - Config File Docs #1912

Merged
merged 19 commits into from
Jul 27, 2023
Merged

1216 - Config File Docs #1912

merged 19 commits into from
Jul 27, 2023

Conversation

cmwylie19
Copy link
Contributor

Description

Closes #1216

  • Move the config-file section to it's own page (still linked from a shorter section in the CLI page)
  • Provide examples of the high-level config file keys on that page and descriptions of what they do / how to use them (with toml, json, and yaml versions in tabs like we have on components now)
  • Describe more specifically where the config files load from - Home directory, CWD, ENV Var location.

Related Issue

Fixes #1216

Relates to #

Type of change

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

Checklist before merging

cmwylie19 added 2 commits July 20, 2023 19:20
@cmwylie19
[TASK] initial work on declarative cli
4f08da3 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
@cmwylie19
[TASK] new docs around config file
1e372c5 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
@netlify
Copy link

netlify bot commented Jul 20, 2023 •
edited
Loading

✅ Deploy Preview for zarf-docs canceled.

Name Link
🔨 Latest commit ca91812
🔍 Latest deploy log https://app.netlify.com/sites/zarf-docs/deploys/64c2ca1b9bcce40008a7ff8a

Racer159
Racer159 requested changes Jul 23, 2023
View reviewed changes
docs-website/plugins/custom-loaders/index.js Outdated Show resolved Hide resolved
docs-website/src/components/ExampleYAML.js Outdated Show resolved Hide resolved
docs/2-the-zarf-cli/2-declarative-cli-configuration.md Outdated Show resolved Hide resolved
docs/2-the-zarf-cli/2-declarative-cli-configuration.md Outdated Show resolved Hide resolved
docs/2-the-zarf-cli/2-declarative-cli-configuration.md Outdated Show resolved Hide resolved
docs/2-the-zarf-cli/2-declarative-cli-configuration.md Outdated Show resolved Hide resolved
docs/2-the-zarf-cli/2-declarative-cli-configuration.md Outdated Show resolved Hide resolved
docs/2-the-zarf-cli/2-declarative-cli-configuration.md Outdated Show resolved Hide resolved
docs/2-the-zarf-cli/2-declarative-cli-configuration.md Outdated Show resolved Hide resolved
examples/config-file/zarf-config.json Outdated Show resolved Hide resolved
cmwylie19 and others added 5 commits July 24, 2023 08:05
@cmwylie19 @Racer159
Update docs-website/plugins/custom-loaders/index.js
b33b871 
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
@cmwylie19
[TASK] address PR comments
5cf3bc7 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
@cmwylie19
[TASK] add comma back to rules array
b7d0864 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
@cmwylie19
remove my-cool-env.yaml
67dea8f 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
@cmwylie19
[TASK] copy injector work for BB test
5ffc559 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
Racer159
Racer159 requested changes Jul 26, 2023
View reviewed changes
docs-website/plugins/custom-loaders/index.js Outdated Show resolved Hide resolved
docs-website/src/components/ExampleYAML.js Outdated Show resolved Hide resolved
docs-website/src/components/FetchFileCodeBlock.js Outdated Show resolved Hide resolved
src/injector/.cargo/config Outdated Show resolved Hide resolved
src/injector/.gitignore Outdated Show resolved Hide resolved
src/injector/Cargo.lock Outdated Show resolved Hide resolved
src/injector/Cargo.toml Outdated Show resolved Hide resolved
src/injector/Makefile Outdated Show resolved Hide resolved
docs-website/src/components/FetchFileCodeBlock.js Outdated Show resolved Hide resolved
cmwylie19 and others added 10 commits July 26, 2023 18:42
@cmwylie19 @Racer159
Update docs-website/src/components/FetchFileCodeBlock.js
db861e1 
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
@cmwylie19
remove cargo changes
2363e42 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
@cmwylie19
Address PR comments
dd6a1b4 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
@cmwylie19
pipeline bb
39823ac 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
@cmwylie19
pipeline bb
c82d982 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
@cmwylie19
Merge branch 'main' into 1216
f0ba347
@cmwylie19
newline
f96d482 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
@cmwylie19
main branch
cd1ff10 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
@cmwylie19
update bb test
fb0ea72 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
@cmwylie19
update bb test with env
d29d6b8 
Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
cmwylie19 and others added 2 commits July 27, 2023 15:48
@cmwylie19 @Racer159
Update docs-website/src/components/FetchFileCodeBlock.js
bf43156 
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
@cmwylie19 @Racer159
Update docs-website/src/components/FetchFileCodeBlock.js
ca91812 
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Racer159
Racer159 approved these changes Jul 27, 2023
View reviewed changes
Copy link
Contributor

@Racer159 Racer159 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@Racer159 Racer159 enabled auto-merge (squash) July 27, 2023 20:05
@Racer159 Racer159 merged commit 63d11bd into main Jul 27, 2023
@Racer159 Racer159 deleted the 1216 branch July 27, 2023 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Racer159 Racer159 Racer159 approved these changes

@mike-winberry mike-winberry Awaiting requested review from mike-winberry

@Noxsios Noxsios Awaiting requested review from Noxsios

@jeff-mccoy jeff-mccoy Awaiting requested review from jeff-mccoy

@YrrepNoj YrrepNoj Awaiting requested review from YrrepNoj

@Madeline-UX Madeline-UX Awaiting requested review from Madeline-UX

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve the docs for the Zarf config-file
3 participants
@cmwylie19 @Racer159 @Noxsios