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

Add short descriptions to contributor docs #6866

Merged
merged 3 commits into from
Mar 23, 2024

Conversation

davepagurek
Copy link
Contributor

This adds a short description to the top of each contributor doc within an HTML comment. These won't show up publicly on GitHub, but will be parsed out by the new website infrastructure and will be used on the contributor docs listing.

@@ -1,3 +1,5 @@
<!-- What our commitment to access means for contributors and users of the library. -->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @natdecker, please take a look at the one-line description of the access statement and share any feedback if you might have. Thanks!

@Qianqianye
Copy link
Contributor

Qianqianye commented Mar 15, 2024

Thanks @davepagurek. While we are adding one-line description to the contributor docs, we need to archive or remove some of the contributor docs. For example, organization.md is supposed to be merged to Steward Guidelines. I can work with @limzykenneth to organize some of the 'older' contributor docs.

@Qianqianye
Copy link
Contributor

Hi @davepagurek, could you rebase this PR on #6906? Thanks!

@davepagurek davepagurek force-pushed the contributor-docs-descriptions branch from 1b672e5 to 15a86b5 Compare March 22, 2024 23:34
@davepagurek
Copy link
Contributor Author

All rebased now!

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.

2 participants