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

Spelling grammar #1276

Merged
merged 24 commits into from
Jan 31, 2023
Merged

Spelling grammar #1276

merged 24 commits into from
Jan 31, 2023

Conversation

bdfinst
Copy link
Contributor

@bdfinst bdfinst commented Jan 27, 2023

Description

MD Linting
Correct sidebar menu titles for Zarf commands
Improve tone
Correct spelling issues
Correct grammar issues

@netlify
Copy link

netlify bot commented Jan 30, 2023

Deploy Preview for zarf-docs failed.

Name Link
🔨 Latest commit f9e26f1
🔍 Latest deploy log https://app.netlify.com/sites/zarf-docs/deploys/63d8066ecb0e540009ead6c9

@YrrepNoj
Copy link
Contributor

@bdfinst When you get the chance, can you run the make target make docs-and-schema. That command will auto-generate all of the docs based off the Go struct schemas.

(If pre-commit gives you any formatting complaints please ignore them, the pipeline is testing for any diffs against the same make target.)

@bdfinst
Copy link
Contributor Author

bdfinst commented Jan 30, 2023

@bdfinst When you get the chance, can you run the make target make docs-and-schema. That command will auto-generate all of the docs based off the Go struct schemas.

(If pre-commit gives you any formatting complaints please ignore them, the pipeline is testing for any diffs against the same make target.)
@YrrepNoj - Yep, done. I had to write a script to modify the files after generation to correct the sidebar menus.

docs/12-support.md Show resolved Hide resolved
docs/3-getting-started.md Outdated Show resolved Hide resolved
docs/3-getting-started.md Show resolved Hide resolved
@jeff-mccoy jeff-mccoy merged commit e005c00 into main Jan 31, 2023
@jeff-mccoy jeff-mccoy deleted the spelling-grammar branch January 31, 2023 18:56
Noxsios pushed a commit that referenced this pull request Mar 8, 2023
## Description

MD Linting
Correct sidebar menu titles for Zarf commands
Improve tone
Correct spelling issues
Correct grammar issues

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

4 participants