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

[Doc] - Update link to the contribution guide #10307

Merged
merged 1 commit into from
Feb 24, 2020
Merged

[Doc] - Update link to the contribution guide #10307

merged 1 commit into from
Feb 24, 2020

Conversation

manuelbuil
Copy link
Contributor

@manuelbuil manuelbuil commented Feb 24, 2020

The link was outdated and pointing nowhere

Signed-off-by: Manuel Buil [email protected]


This change is Reviewable

@manuelbuil manuelbuil requested a review from a team as a code owner February 24, 2020 14:27
The link was outdated and pointing nowhere

Signed-off-by: Manuel Buil <[email protected]>
@manuelbuil manuelbuil changed the title Update link to the contribution guide [Doc] - Update link to the contribution guide Feb 24, 2020
@pchaigno
Copy link
Member

This is not the first such pull request. Maybe we should reintroduce contributing/contributing/ and set up a redirect?

@pchaigno pchaigno added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. pending-review release-note/misc This PR makes changes that have no direct user impact. labels Feb 24, 2020
@coveralls
Copy link

Coverage Status

Coverage increased (+0.01%) to 45.524% when pulling 6edb33d on manuelbuil:master into f104521 on cilium:master.

@tgraf
Copy link
Member

tgraf commented Feb 24, 2020

This is not the first such pull request. Maybe we should reintroduce contributing/contributing/ and set up a redirect?

Do you see a common scenario where users will run into the old link once it is fixed? Some cached version?

@tgraf tgraf merged commit 15edf1a into cilium:master Feb 24, 2020
@pchaigno
Copy link
Member

Do you see a common scenario where users will run into the old link once it is fixed? Some cached version?

Any user that's on an older version of the documentation (e.g., because they landed there from a Google search) and switches to latest will get a 404.

@tgraf
Copy link
Member

tgraf commented Feb 24, 2020

Any user that's on an older version of the documentation (e.g., because they landed there from a Google search) and switches to latest will get a 404.

Are you referring to the Cilium documentation? The broken link was in the CONTRIBUTING.mdof the git tree. I would assume that developers will typically look at the version inmaster` when looking at this file and not in older branches.

@pchaigno
Copy link
Member

I'm referring to the Read the docs documentation, not files in the repository. Even once we've found all broken links to contributing/contributing/ in the sources, we'll still have a broken redirect on Read the docs when switching between versions of the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

4 participants