Skip to content

doc: Fix links to contributing guide #10322

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Feb 27, 2020
Merged

doc: Fix links to contributing guide #10322

merged 4 commits into from
Feb 27, 2020

Conversation

CybrPunk
Copy link
Contributor

@CybrPunk CybrPunk commented Feb 24, 2020 •
edited by tgraf
Loading

Fixes the link to the contributing guide in the main README.rst and cilium-actions.yaml
The previous link pointed to a folder structure that had changed recently.
Fixes: #10316

This change is Reviewable

@CybrPunk CybrPunk requested a review from a team as a code owner February 24, 2020 20:06
@maintainer-s-little-helper
Copy link

Commits f308ac0683544d5603461e3f85ac986880f65e56, fd9d0662e67dd84db71216d8c824783e2f296e6b do not contain "Signed-off-by".

Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin

@maintainer-s-little-helper
Copy link

Release note label not set, please set the appropriate release note.

@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. label Feb 24, 2020
@maintainer-s-little-helper
Copy link

Release note label not set, please set the appropriate release note.

@pchaigno pchaigno added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. labels Feb 24, 2020
pchaigno
pchaigno reviewed Feb 24, 2020
View reviewed changes
.github/cilium-actions.yml Outdated
@@ -33,7 +33,7 @@ move-to-projects-for-labels-xored:
column: "Backport done to v1.5"
require-msgs-in-commit:
- msg: "Signed-off-by"
helper: "https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin"
helper: "http://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin"
Copy link
Member

Choose a reason for hiding this comment

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

Any reason you switched to http?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hadn't realized I did, I followed a link from the readme which uses http, copied the whole url and pasted it....

Copy link
Member

@pchaigno pchaigno Feb 24, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Could you please revert this change and sign off your commit?

@pchaigno
Copy link
Member

test-docs-please

@coveralls
Copy link

coveralls commented Feb 24, 2020 •
edited
Loading

Coverage Status

Coverage decreased (-0.02%) to 45.507% when pulling 59fc725 on CybrPunk:contributing-docs-fix into a7e642c on cilium:master.

@maintainer-s-little-helper
Copy link

Commits f308ac0683544d5603461e3f85ac986880f65e56, fd9d0662e67dd84db71216d8c824783e2f296e6b, 0c1e380f7d42c5a2ae3c1e9195ab8fe382e1c7bf, 8e91d93e1cc35a12f475efce7e6178ae201cec2f do not contain "Signed-off-by".

Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/contributing/#developer-s-certificate-of-origin

joestringer
joestringer reviewed Feb 24, 2020
View reviewed changes
Copy link
Member

@joestringer joestringer left a comment

Choose a reason for hiding this comment

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

FYI, since apparently those docs don't point it out:

If you git config user.name "John Doe" and git config user.email "john@doe.com" then when committing the code you do git commit -s (or git commit --amend -s), the signoff line will be populated by git.

I think it'd be worthwhile to add this to the instructions too.

@CybrPunk
Fix maintainers little helper link to contributing docs
47d88df 
Fixes: cilium#10316
Signed-off-by: Sean Winn <sean@isovalent.com>
@CybrPunk
Fix contributing link in readme
a322e23 
Fixes: cilium#10316
Signed-off-by: Sean Winn <sean@isovalent.com>
@CybrPunk
Revert "Fix maintainers little helper link to contributing docs"
ef7afbd 
This reverts commit f308ac0683544d5603461e3f85ac986880f65e56.
Signed-off-by: Sean Winn <sean@isovalent.com>
@CybrPunk
Fixes maintainers little helper link to contributing guide
59fc725 
Fixes: cilium#10316
Signed-off-by: Sean Winn <sean@isovalent.com>
@CybrPunk CybrPunk force-pushed the contributing-docs-fix branch from 8e91d93 to 59fc725 Compare February 24, 2020 21:13
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. label Feb 24, 2020
jrajahalme
jrajahalme approved these changes Feb 26, 2020
View reviewed changes
Copy link
Member

@jrajahalme jrajahalme left a comment

Choose a reason for hiding this comment

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

I'd prefer these four commits to be squashed together to ease backporting (if needed).

@joestringer
Copy link
Member

test-docs-please

@joestringer joestringer merged commit f8b65ed into cilium:master Feb 27, 2020
@brb brb mentioned this pull request Feb 27, 2020
Merged
@brb brb mentioned this pull request Mar 2, 2020
Merged
@jrajahalme jrajahalme mentioned this pull request Mar 4, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joestringer joestringer joestringer left review comments

@pchaigno pchaigno pchaigno left review comments

@jrajahalme jrajahalme jrajahalme approved these changes

Assignees
No one assigned
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation links to https://docs.cilium.io/en/stable/contributing/contributing/ fail
6 participants
@CybrPunk @pchaigno @coveralls @joestringer @jrajahalme @brb