📖 dead contributor and conduct links on cluster-api.sigs.k8s.io website

[thesystemninjaneer]

What this PR does / why we need it:
Addresses two dead links on the README.md doc. Fixes #1816

Learning how to first time contribute code to this SIG by reading https://cluster-api.sigs.k8s.io/ and found a couple dead links in the documentation. Killing two birds with one stone by confirming my understanding of how to first time contribute by contributing a patch to those same docs! 🐦 🐦

There were a lot of docs about how to contribute so please let me know if I missed any steps!

[k8s-ci-robot]

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

---

• If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
• If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
• If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
• Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

[k8s-ci-robot]

Welcome @thesystemninjaneer!

It looks like this is your first PR to kubernetes-sigs/cluster-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @thesystemninjaneer. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[thesystemninjaneer]

I signed it

[thesystemninjaneer]

/assign @justinsb

[k8s-ci-robot]

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

---

• If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
• If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
• If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
• Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

[vincepri]

@thesystemninjaneer The commit message shouldn't include "fixes #1816" text, can you remove it and push it again?

[vincepri]

Looking at the preview https://5de51c124c02dc0008034637--kubernetes-sigs-cluster-api.netlify.com/ for this change, it seems like the links aren't fixed. We need to change the links to be full domains, e.g. contributor guide should point to https://github.com/kubernetes-sigs/cluster-api/blob/master/CONTRIBUTING.md

[thesystemninjaneer]

@vincepri Sure. I can remove that comment and also burn in the path to the markdown files in the repo.

[vincepri]

/ok-to-test

[vincepri]

@detiber We have both defined locally, but that part of the readme is referenced in the quick start, and local references end up not working

[detiber]

@detiber We have both defined locally, but that part of the readme is referenced in the quick start, and local references end up not working

This seems a bit error prone to hardcode to the master branch here... Is this something that we should potentially translate as part of the build process somehow to reference the proper branch?

[vincepri]

We can probably remove those parts or overwrite the links in the quick start

[ncdc]

@vincepri @detiber did you all come to a resolution on your discussion here?

[detiber]

@ncdc I'm good with either of the approaches that @vincepri mentioned (excluding or overwriting at generation time).

[thesystemninjaneer]

@vincepri @detiber shall i push in changes like this https://github.com/kubernetes-sigs/cluster-api/pull/1832/files?

[detiber]

@vincepri @detiber shall i push in changes like this https://github.com/kubernetes-sigs/cluster-api/pull/1832/files?

Ah, that could work as well.

[vincepri]

/approve
/lgtm
/retest

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: thesystemninjaneer, vincepri

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [vincepri]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[vincepri]

/lgtm cancel

[vincepri]

@thesystemninjaneer Are you able to make the changes @detiber suggested? Otherwise, we should open an issue to track the link generation work instead.

[thesystemninjaneer]

@vincepri yup. I'll work it this weekend. Are there any instructions to manually build the repo's mdocs? I'd like to test my changes locally.

[vincepri]

You can run make serve-book to run a local server

[thesystemninjaneer]

@thesystemninjaneer Are you able to make the changes @detiber suggested? Otherwise, we should open an issue to track the link generation work instead.

Changes made. Tested locally with a centos 8 container

[detiber]

/lgtm