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

Docs updates to "Common CLI Uses" page #1533

Merged
merged 6 commits into from
Mar 31, 2023
Merged

Docs updates to "Common CLI Uses" page #1533

merged 6 commits into from
Mar 31, 2023

Conversation

Jessy-Morris
Copy link
Contributor

Description

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

  • Removing run-on sentences
  • Fixing note admonition
  • Capitalizing K8s/K3s
  • Removing metaphorical language
  • Rewriting to improve user understanding/readability

Related Issue

Fixes #1529

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 Mar 31, 2023
@netlify
Copy link

netlify bot commented Mar 31, 2023 •
edited
Loading

✅ Deploy Preview for zarf-docs canceled.

Name Link
🔨 Latest commit b5a8904
🔍 Latest deploy log https://app.netlify.com/sites/zarf-docs/deploys/642746a7b1f20100084b5bb3

@Racer159 Racer159 enabled auto-merge (squash) March 31, 2023 20:50
Racer159
Racer159 approved these changes Mar 31, 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 merged commit 86ca845 into main Mar 31, 2023
@Racer159 Racer159 deleted the edits-to-common-cli-uses-page branch March 31, 2023 20:50
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

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

@JasonvanBrackel JasonvanBrackel Awaiting requested review from JasonvanBrackel

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

@YrrepNoj YrrepNoj Awaiting requested review from YrrepNoj

@wirewc wirewc Awaiting requested review from wirewc

Assignees
No one assigned
Labels
documentation 📘 Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs edits to "Common CLI Uses" page
2 participants
@Jessy-Morris @Racer159