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

Contributing page needs some love #970

Closed
rynowak opened this issue Nov 20, 2023 · 1 comment · Fixed by #1041
Closed

Contributing page needs some love #970

rynowak opened this issue Nov 20, 2023 · 1 comment · Fixed by #1041
Assignees
Labels

Comments

@rynowak
Copy link
Contributor

rynowak commented Nov 20, 2023

What content needs to be created or modified?

Per discussion with a contributor, the existing contributing docs page wasn't very clear.

I was talking with a contributor, he ultimately needed to find this page, however he started with docs.radapp.io.

Along the way, he saw the existing contributing docs page and didn't think it was the right reference, so he kept looking.

Describe the solution you'd like

It's hard to optimize the docs for every user, but when I look at the page it's clear that we could make some improvements.

These are ideas and we don't have to all of them.

  • Do we want to move Contributing to lop level in the TOC?
  • Do we want to add more tags/keywords in case users aren't thinking about the term contributing eg: repo, code, pull-request, issue.
  • I think we could expand the intro to this page. It's not very clear what I'm going to find at these links.
  • We should reorder this table to put project-radius/radius and project-radius/docs at the top.
  • We should rephrase Radius control plane to something more general. If you don't know what control plane means you're not likely to click it. ~50% of contributors will end up in the Radius repo, and the other ~50% in docs.
  • The project-radius/radius link should go to: https://github.com/radius-project/radius/blob/main/CONTRIBUTING.md
  • We should remove templates

Where should the new material be placed?

https://docs.radapp.io/community/contributing/overview/

The associated pull request from the Radius code repo, if applicable

Additional context

AB#10422

@nicolejms
Copy link

specifically on the doc side...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants