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

Redirect users to Contributing Guide Directly #659

Closed
adithyaakrishna opened this issue Mar 17, 2023 · 5 comments · Fixed by #710
Closed

Redirect users to Contributing Guide Directly #659

adithyaakrishna opened this issue Mar 17, 2023 · 5 comments · Fixed by #710
Labels
good-first-issue Identifies an issue that has been specifically created or selected for first-time contributors.

Comments

@adithyaakrishna
Copy link
Contributor

adithyaakrishna commented Mar 17, 2023

Description:

Instead of directing users from https://github.com/kubevirt/user-guide/blob/main/CONTRIBUTING.md to https://github.com/kubevirt/community/blob/main/contributors/contributing.md and from there to https://kubevirt.io/user-guide/appendix/contributing/ - ( which is currently giving a 404 Error. I have fixed the link and created a PR for the same here, kubevirt/community#214 ), how about we do it directly from the user-guide to https://kubevirt.io/user-guide/contributing/

Another option, we can redirect them directly to https://github.com/kubevirt/kubevirt/blob/main/CONTRIBUTING.md

So the users instead of traversing through the maze, will be taken directly from user-guide to https://kubevirt.io/user-guide/contributing/

Fixed by #710

@adithyaakrishna
Copy link
Contributor Author

@aburdenthehand @petrkotas Would love to know your opinion on this 👀

@cwilkers cwilkers added the good-first-issue Identifies an issue that has been specifically created or selected for first-time contributors. label Mar 27, 2023
@cwilkers
Copy link
Member

I agree, we should point to a centralized start page for new contributors, and it looks like that is currently https://kubevirt.io/user-guide/contributing/.

For repos that have their own guide (such as kubevirt and user-guide) the individual repo's README.md should point both to the website contributing page and to the local repo contribution guide. The website guide should have a section that branches to all these individual guides in a clear way so potential contributors can get the boilerplate items like CNCF policy, KubeVirt code of conduct, and DCO signoffs in a central place before getting to more specific work.

@kubevirt-bot
Copy link
Contributor

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@kubevirt-bot kubevirt-bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 25, 2023
@aburdenthehand aburdenthehand removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jul 21, 2023
@aburdenthehand
Copy link
Member

@adithyaakrishna Were you still interested in working on this?
To add to Chandler's suggestion, I think pointing to our governance and membership policy documents would be really helpful as well.
I've also created #701 to include a simple style/convention guide to the user-guide contrib page.
All this needn't all be captured in a single PR, but perhaps we can make use of the Projects function of github and track this work there.

@cwilkers
Copy link
Member

cwilkers commented Oct 4, 2023

I think this was fixed in #710, we can close now.

@cwilkers cwilkers closed this as completed Oct 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good-first-issue Identifies an issue that has been specifically created or selected for first-time contributors.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants