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

Update readme content #672

Merged
merged 32 commits into from
Aug 22, 2022
Merged

Update readme content #672

merged 32 commits into from
Aug 22, 2022

Conversation

Racer159
Copy link
Contributor

Description

This updates the README to reference docs and be visually cleaner.

Related Issue

None

Type of change

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

Checklist before merging

  • (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
Copy link
Contributor Author

Still need to do copy edits and finalization but this should provide a better structure.

@Racer159 Racer159 marked this pull request as draft August 14, 2022 04:08
@Racer159 Racer159 marked this pull request as ready for review August 15, 2022 15:39
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@Racer159 Racer159 requested a review from YrrepNoj August 15, 2022 17:56
@jeff-mccoy
Copy link
Contributor

Love all the badges and how much simpler/cleaner this is overall. I do want to fiddle with the wording a bit more in the first section. Feel like we do need a bullet point list of what zarf does / what it's major features are. Also the supported OS link seems to be dead. Would like to get a "build passing" badge too, but think we'd need to have an actual k3s test run on master for that to work. We do it on release right now. Lastly, we desperately need to update the demo to something more up to date, i can try to do that this week.

@jeff-mccoy
Copy link
Contributor

See #632 for some ideas we can look at adding for the bullet point list.

@Racer159
Copy link
Contributor Author

Love all the badges and how much simpler/cleaner this is overall. I do want to fiddle with the wording a bit more in the first section. Feel like we do need a bullet point list of what zarf does / what it's major features are. Also the supported OS link seems to be dead. Would like to get a "build passing" badge too, but think we'd need to have an actual k3s test run on master for that to work. We do it on release right now. Lastly, we desperately need to update the demo to something more up to date, i can try to do that this week.

Will take a stab at updating that text. Where do you see the release action output? I only see where we build and push the release packages not the binary itself.

@YrrepNoj
Copy link
Contributor

I like the way the AlexAivazis/survey project does GIFs in their README. It looks like they use gfycat so that playing the GIF doesn't open the link into a new tab and taking you away from the README.

jeff-mccoy
jeff-mccoy previously approved these changes Aug 22, 2022
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.

This is a huge improvement over the prior readme, thanks! I made a few changes I'd like you to double-check before we merge @Racer159 or @YrrepNoj

@jeff-mccoy jeff-mccoy added the documentation 📘 Improvements or additions to documentation label Aug 22, 2022
@Racer159
Copy link
Contributor Author

@jeff-mccoy fixed a small grammatical issue but otherwise looks good!

@jeff-mccoy jeff-mccoy merged commit 4d37d55 into master Aug 22, 2022
@jeff-mccoy jeff-mccoy deleted the update-readme-content branch August 22, 2022 14:42
Noxsios pushed a commit that referenced this pull request Mar 8, 2023
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.

3 participants