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

Update example READMEs #681

Merged
merged 27 commits into from
Aug 23, 2022
Merged

Update example READMEs #681

merged 27 commits into from
Aug 23, 2022

Conversation

Racer159
Copy link
Contributor

Description

This PR updates the examples to be simpler and to accurately reflect the current state of Zarf. Will add a PR to the zarf-docs repo to pull these in as well.

Related Issue

Fixes #676

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Checklist before merging

  • Documentation has been updated as necessary (add the needs-docs label)
  • (Optional) Changes have been linted locally with golangci-lint. (NOTE: We haven't turned on lint checks in the pipeline yet so linting may be hard if it shows a lot of lint errors in places that weren't touched by changes. Thus, linting is optional right now.)

@Racer159 Racer159 marked this pull request as draft August 17, 2022 21:18
@Racer159 Racer159 changed the title Update example READMEs (initial) Update example READMEs Aug 17, 2022
@jeff-mccoy jeff-mccoy added documentation 📘 Improvements or additions to documentation examples labels Aug 22, 2022
@Racer159 Racer159 mentioned this pull request Aug 22, 2022
Merged
@Racer159 Racer159 marked this pull request as ready for review August 22, 2022 18:39
jeff-mccoy
jeff-mccoy reviewed Aug 23, 2022
View reviewed changes
Copy link
Member

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

just a couple comments, overall fantastic / detailed work.

@jeff-mccoy jeff-mccoy merged commit 800c5b1 into master Aug 23, 2022
@jeff-mccoy jeff-mccoy deleted the 676-example-readmes-are-out-of-date branch August 23, 2022 16:12
Noxsios pushed a commit that referenced this pull request Mar 8, 2023
@Racer159 @jeff-mccoy
Update example READMEs (#681)
87517ea 
* Update example READMEs (initial)

* Refine docs for docusaurus

* Fix walkthroughs

* Update the git-data Makefile

* Fix tests with renamed git-data example

* Update logging png image

* Resolve bad markdown syntax

* Test autogenerated index

* Cleanup example headings and paths

* Tell people to click edit instead of a direct link

* Cleanup example note

* Cleanup example link verbiage

* Fix examples link

* Remove Examples to prevent double

* Fix CONTRIBUTING.md link

* Fix packages links

* Desiccate the contributing guide

* Address PR feedback

* Resolve bad links

* Fix images in user guide and overview

* use zarf tools monitor instead of kubectl

* use zarf tools monitor instead of kubectl

Co-authored-by: Megamind <882485+jeff-mccoy@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeff-mccoy jeff-mccoy jeff-mccoy approved these changes

@YrrepNoj YrrepNoj Awaiting requested review from YrrepNoj

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.

Example READMEs are out of date
2 participants
@Racer159 @jeff-mccoy