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

Make schema documentation more useful #1381

Merged
merged 14 commits into from
Feb 26, 2023

Conversation

Racer159
Copy link
Contributor

Description

This PR cleans up the schema page adding some examples, and allowing searchability / linking

Related Issue

Fixes #1366

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

@netlify
Copy link

netlify bot commented Feb 24, 2023

Deploy Preview for zarf-docs ready!

Name Link
🔨 Latest commit 25e6428
🔍 Latest deploy log https://app.netlify.com/sites/zarf-docs/deploys/63fab0d0053f730007b44089
😎 Deploy Preview https://deploy-preview-1381--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 Racer159 changed the title Some initial changes/experiments Make schema documentation more useful Feb 24, 2023
Madeline-UX
Madeline-UX previously approved these changes Feb 24, 2023
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.

CODEOWNERS change good, and doc preview is def. an improvement.

@Racer159 Racer159 merged commit ed69395 into main Feb 26, 2023
@Racer159 Racer159 deleted the 1366-zarf-package-schema-lacks-clarity branch February 26, 2023 02:34
Noxsios pushed a commit that referenced this pull request Mar 8, 2023
## Description

This PR cleans up the schema page adding some examples, and allowing
searchability / linking

## Related Issue

Fixes #1366

## Type of change

- [X] 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

- [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
Noxsios pushed a commit that referenced this pull request Mar 8, 2023
## Description

This PR cleans up the schema page adding some examples, and allowing
searchability / linking

## Related Issue

Fixes #1366

## Type of change

- [X] 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

- [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

Signed-off-by: razzle <[email protected]>
Racer159 added a commit that referenced this pull request Mar 8, 2023
## Description

This PR cleans up the schema page adding some examples, and allowing
searchability / linking

## Related Issue

Fixes #1366

## Type of change

- [X] 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

- [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

Signed-off-by: Wayne Starr <[email protected]>
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.

Zarf Package Schema Lacks Clarity
3 participants