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

606 generate docs from zarf schema json #614

Merged
merged 1 commit into from
Jul 13, 2022
Merged

606 generate docs from zarf schema json #614

merged 1 commit into from
Jul 13, 2022

Conversation

Racer159
Copy link
Contributor

@Racer159 Racer159 commented Jul 11, 2022 •
edited
Loading

Description

Generated markdown from zarf.schema.json to include in docs.

Related Issue

Fixes #606

Type of change

  • New feature (non-breaking change which adds functionality)

Checklist before merging

  • Tests have been added/updated as necessary (add the needs-tests label)
  • Documentation has been updated as necessary (add the needs-docs label)
  • An ADR has been written as necessary (add the needs-adr label) [ 1 2 3 ]
  • (Optional) Changes have been linted locally with golangci-lint. (NOTE: We haven't turned on lint checks in the pipeline yet so linting may be hard if it shows a lot of lint errors in places that weren't touched by changes. Thus, linting is optional right now.)

@Racer159 Racer159 requested a review from YrrepNoj July 11, 2022 23:45
@jeff-mccoy
Copy link
Contributor

Is there a clean way to test / preview this for the docs website? maybe create a PR with the submodule update?

@YrrepNoj
Copy link
Contributor

YrrepNoj commented Jul 12, 2022 •
edited
Loading

Is there a clean way to test / preview this for the docs website? maybe create a PR with the submodule update?
@jeff-mccoy

https://deploy-preview-38--zarf-docs.netlify.app/docs/user-guide/zarf-schema

@Racer159
Copy link
Contributor Author

Racer159 commented Jul 12, 2022 •
edited
Loading

Lol @YrrepNoj https://deploy-preview-39--zarf-docs.netlify.app/docs/user-guide/zarf-schema (now I've got the zarf-docs repo cloned and setup though)

@Racer159
Copy link
Contributor Author

Just made it slightly cleaner to look at (included a link to the zarf.schema.json file)

jeff-mccoy
jeff-mccoy previously approved these changes Jul 13, 2022
View reviewed changes
Copy link
Contributor

@jeff-mccoy jeff-mccoy left a comment

Choose a reason for hiding this comment

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

🥳

@jeff-mccoy
Copy link
Contributor

Boo missed signing a commit, need that fixed to merge. Screen Shot 2022-07-12 at 8 21 43 PM

@Racer159 Racer159 force-pushed the 606-generate-docs-from-zarf-schema-json branch from 9b702c6 to 38c9da7 Compare July 13, 2022 02:32
@Racer159
Copy link
Contributor Author

Racer159 commented Jul 13, 2022 •
edited
Loading

Boo missed signing a commit, need that fixed to merge. Screen Shot 2022-07-12 at 8 21 43 PM
Squashed all the commits and resigned (was a lot of junk tests anyway). Is there a way we can set all branches to require signing?

jeff-mccoy
jeff-mccoy approved these changes Jul 13, 2022
View reviewed changes
Copy link
Contributor

@jeff-mccoy jeff-mccoy left a comment

Choose a reason for hiding this comment

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

lgtm thx

@jeff-mccoy jeff-mccoy merged commit 5c9ea31 into master Jul 13, 2022
@jeff-mccoy jeff-mccoy deleted the 606-generate-docs-from-zarf-schema-json branch July 13, 2022 03:17
Noxsios pushed a commit that referenced this pull request Mar 8, 2023
@Racer159
generate docs from zarf schema json (#614)
26e7165
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeff-mccoy jeff-mccoy jeff-mccoy approved these changes

@YrrepNoj YrrepNoj Awaiting requested review from YrrepNoj

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

Successfully merging this pull request may close these issues.

Generate docs from zarf.schema.json
3 participants
@Racer159 @jeff-mccoy @YrrepNoj