Cleanup top level README for better user experience #363
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Riaan Kleinhans <61125752+Riaankl@users.noreply.github.com>
Signed-off-by: Riaan Kleinhans <61125752+Riaankl@users.noreply.github.com>
Signed-off-by: Riaan Kleinhans <61125752+Riaankl@users.noreply.github.com>
Signed-off-by: Riaan Kleinhans <61125752+Riaankl@users.noreply.github.com>
Signed-off-by: Riaan Kleinhans <61125752+Riaankl@users.noreply.github.com>
carolynvs
reviewed
Apr 6, 2023
README.md
Outdated
|
|
||
| - Dave Sudia ([@thedevelopnik](https://github.com/thedevelopnik)), Ambassador Labs | ||
| - Paris Pittman ([@parispittman](https://github.com/parispittman)), Apple | ||
| Status: [Proposed](https://github.com/cncf/tag-contributor-strategy/issues/1) |
There was a problem hiding this comment.
We can remove this status paragraph here, the Maintainer's Circle is accepted.
There was a problem hiding this comment.
Removed. Thanks
Signed-off-by: Riaan Kleinhans <61125752+Riaankl@users.noreply.github.com>
Co-authored-by: Carolyn Van Slyck <me@carolynvanslyck.com> Signed-off-by: Riaan Kleinhans <61125752+Riaankl@users.noreply.github.com>
Co-authored-by: Carolyn Van Slyck <me@carolynvanslyck.com> Signed-off-by: Riaan Kleinhans <61125752+Riaankl@users.noreply.github.com>
Signed-off-by: Riaan Kleinhans <61125752+Riaankl@users.noreply.github.com>
Signed-off-by: Riaan Kleinhans <61125752+Riaankl@users.noreply.github.com>
Signed-off-by: Riaan Kleinhans <61125752+Riaankl@users.noreply.github.com>
README.md
Outdated
| and projects with their own contributor strategies for a healthy project. | ||
|
|
||
| If you are looking for how-to resources produced by the TAG, please visit | ||
| [contribute.cncf.io](https://contribute.cncf.io/) or have a look at the | ||
| contributor, goverance, and related [templates](https://github.com/cncf/project-template). | ||
|
|
||
| For people new to this space, you can learn more about [CNCF TAG's](https://github.com/cncf/toc/blob/main/tags/cncf-tags.md) by following the link. |
There was a problem hiding this comment.
Suggested change
| For people new to this space, you can learn more about [CNCF TAG's](https://github.com/cncf/toc/blob/main/tags/cncf-tags.md) by following the link. | |
| For people new to this space, you can learn more about the purpose, objectives, and responsibilities of [CNCF TAGs](https://github.com/cncf/toc/blob/main/tags/cncf-tags.md). |
There was a problem hiding this comment.
In general, I have a preference for not saying "follow this link" since it's implied anyway, but this is just my personal pet peeve, so I reworded it a bit to say more about what they could find out about the TAGs :)
There was a problem hiding this comment.
Agree. Updated. Thank you.
There was a problem hiding this comment.
Agree. Updated. Thank you.
Co-authored-by: Dawn Foster <geekygirldawn@gmail.com> Signed-off-by: Riaan Kleinhans <61125752+Riaankl@users.noreply.github.com>
jberkus
approved these changes
Apr 13, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why is this PR needed?
We are in the process collecting info about the work of TAG CS to help with "Create a roadmap for the TAG #341"
Big part of the task for me is to understand the relationship between TAG CS and it's teams & WG's
I created a document about the information I found in the repo and Jay has created a great visual presentation of it. I added links to them in the next TAG CS meeting agenda.
As part of the review of the repo I created this PR to cleanup the top level README for a better user experience. (Especially for people that have no idea what we do or what "TAG" means.)
A second step could be to look at gaps in information and reviewing the charters to maybe have the same flow and information body.
I am starting with a small PR to help make the review burden as light as possible.