You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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.
Contributing
to lop level in the TOC?contributing
eg:repo
,code
,pull-request
,issue
.project-radius/radius
andproject-radius/docs
at the top.Radius control plane
to something more general. If you don't know whatcontrol 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.project-radius/radius
link should go to: https://github.com/radius-project/radius/blob/main/CONTRIBUTING.mdWhere 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
The text was updated successfully, but these errors were encountered: