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

Update schema docs to include information about OCI registries for helm charts #1464

Merged
merged 12 commits into from
Mar 27, 2023

Conversation

lucasrod16
Copy link
Contributor

@lucasrod16 lucasrod16 commented Mar 21, 2023

Description

  • Updates schema docs to include information about OCI registries for helm charts
  • Updates contributing guide to include information about regenerating schema and docs when an update to the docs is made

Related Issue

Fixes #1463

Type of change

  • Other (security config, docs update, etc)

Checklist before merging

@netlify
Copy link

netlify bot commented Mar 21, 2023

Deploy Preview for zarf-docs ready!

Name Link
🔨 Latest commit 7f734e4
🔍 Latest deploy log https://app.netlify.com/sites/zarf-docs/deploys/6421cf78495bdf0008a05f05
😎 Deploy Preview https://deploy-preview-1464--zarf-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@Racer159
Copy link
Contributor

@lucasrod16 looks like you need to run make docs-and-schema and commit the generated changes

@lucasrod16
Copy link
Contributor Author

@lucasrod16 looks like you need to run make docs-and-schema and commit the generated changes

@Racer159 Ahh I see, thanks! Is the purpose of that to ensure that all of the right references got updated when there's an update to the docs? I can add that step and describe when it should be used to the CONTRIBUTING.md if desired.

@lucasrod16
Copy link
Contributor Author

@Racer159 when I'm running make docs-and-schema it's stripping away the description after the first comma to be The URL of the OCI registry. I'll go ahead and put this PR in draft status until I resolve it. Any suggestions?

@lucasrod16 lucasrod16 marked this pull request as draft March 21, 2023 22:25
@Racer159
Copy link
Contributor

Racer159 commented Mar 22, 2023

@lucasrod16 yeah the reason it cuts it off is because the values there are comma separated - to do a description with commas you have to use jsonschema_description as in: https://github.com/defenseunicorns/zarf/blob/cbf3c04dbaa568f0010c4dfb2db1f317ead3f9c3/src/types/package.go#L30

And if you can add a reference to that in the contributing guide that would be great! The purpose of make docs-and-schema is to update our auto generated docs - we force people to do this (rather than CI) so that there is a git commit signature from a person on the commit for better traceability (rather than an non-person entity Github CI token)

@lucasrod16
Copy link
Contributor Author

@lucasrod16 yeah the reason it cuts it off is because the values there are comma separated - to do a description with commas you have to use jsonschema_description as in:

https://github.com/defenseunicorns/zarf/blob/cbf3c04dbaa568f0010c4dfb2db1f317ead3f9c3/src/types/package.go#L30

And if you can add a reference to that in the contributing guide that would be great! The purpose of make docs-and-schema is to update our auto generated docs - we force people to do this (rather than CI) so that there is a git commit signature from a person on the commit for better traceability (rather than an non-person entity Github CI token)

@Racer159 Thanks! I made the jsonschema_description update and added examples as well. I will also add a section about running make docs-and-schema in the contributing guide

@lucasrod16 lucasrod16 marked this pull request as ready for review March 23, 2023 18:58
@lucasrod16
Copy link
Contributor Author

@Racer159 this is ready for review whenever you get the chance

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.

tiny suggestion but figured more info could be valuable (in case someone ran into this on our command docs too)

CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
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! thanks!

@Racer159 Racer159 enabled auto-merge (squash) March 27, 2023 17:17
@Racer159 Racer159 merged commit fb59f0b into main Mar 27, 2023
@Racer159 Racer159 deleted the update-schema-docs-with-oci-url-info branch March 27, 2023 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs for the Zarf package schema do not specify that a chart URL can be an OCI registry
2 participants