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 edits to "Understanding Zarf Packages" page #1548

Merged
merged 18 commits into from
Apr 7, 2023

Conversation

Jessy-Morris
Copy link
Contributor

Description

Documentation does not reflect the editorial guidelines outlined in the Project Style Guide. Editing the "Understanding Zarf Packages" page to align with the updated Style Guide to improve readability for users.

  • Consolidate information to improve readability
  • Fix "air-gapped" grammar
  • Capitalize K8s/K3s
  • Remove "info" admonition and create list
  • Introduce more straightforward technical/professional language
  • Ensure note formatting is consistent with the style guide
  • Edit headings to maintain consistency

Related Issue

Fixes #1545

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

@Jessy-Morris Jessy-Morris added the documentation 📘 Improvements or additions to documentation label Apr 3, 2023
@netlify
Copy link

netlify bot commented Apr 3, 2023

Deploy Preview for zarf-docs ready!

Name Link
🔨 Latest commit 83b5e66
🔍 Latest deploy log https://app.netlify.com/sites/zarf-docs/deploys/643046b919e32600087b66a6
😎 Deploy Preview https://deploy-preview-1548--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.

docs/4-user-guide/2-zarf-packages/1-zarf-packages.md Outdated Show resolved Hide resolved
docs/4-user-guide/2-zarf-packages/1-zarf-packages.md Outdated Show resolved Hide resolved
docs/4-user-guide/2-zarf-packages/1-zarf-packages.md Outdated Show resolved Hide resolved
docs/4-user-guide/2-zarf-packages/1-zarf-packages.md Outdated Show resolved Hide resolved
docs/4-user-guide/2-zarf-packages/1-zarf-packages.md Outdated Show resolved Hide resolved
docs/4-user-guide/2-zarf-packages/1-zarf-packages.md Outdated Show resolved Hide resolved
docs/4-user-guide/2-zarf-packages/1-zarf-packages.md Outdated Show resolved Hide resolved
docs/4-user-guide/2-zarf-packages/1-zarf-packages.md Outdated Show resolved Hide resolved
docs/4-user-guide/2-zarf-packages/1-zarf-packages.md Outdated Show resolved Hide resolved
docs/4-user-guide/2-zarf-packages/1-zarf-packages.md Outdated Show resolved Hide resolved
Jessy-Morris and others added 17 commits April 4, 2023 11:01
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
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!

@Racer159 Racer159 enabled auto-merge (squash) April 7, 2023 16:37
@Racer159 Racer159 merged commit ca81b80 into main Apr 7, 2023
@Racer159 Racer159 deleted the edits-to-understanding-zarf-packages-page branch April 7, 2023 16:41
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 this pull request may close these issues.

Docs edits to "Understanding Zarf Packages" page
2 participants