Skip to content

Fix dead link in 1.4->1.5 upgrade documentation#10416

Merged
joestringer merged 1 commit intocilium:masterfrom
Ropes:kind/microtask/docs-upgrade-1.5-fix-url
Mar 3, 2020
Merged

Fix dead link in 1.4->1.5 upgrade documentation#10416
joestringer merged 1 commit intocilium:masterfrom
Ropes:kind/microtask/docs-upgrade-1.5-fix-url

Conversation

@Ropes
Copy link
Copy Markdown
Contributor

@Ropes Ropes commented Mar 2, 2020

The broken link was caused by using the 'latest' URL domain and path as
root. \ |SCM_WEB|/examples/kubernetes/1.10/cilium-pre-flight-with-rm-svc-v2.yaml
Therefore the URL picked up the most recent tags, and post 1.5.12 the
path /examples/kubernetes/1.X were removed, so all newly built URLs were broken.
eg: ...githubusercontent.com/cilium/cilium/1.7.0/examples/kubernetes/1.10..., all /1.1X/ do
not exist in tags newer than 1.5.12.

This change makes the URL static to the release path of 1.5.12. If
there are other options to keep the URL tagged within the 1.5.x minor
versions; I'm interested in learning about it, but this is a quick fix.

Fixes: #10391

Signed-off-by: Joshua Roppo joshroppo@gmail.com


This change is Reviewable

@Ropes Ropes requested a review from a team as a code owner March 2, 2020 21:15
@maintainer-s-little-helper
Copy link
Copy Markdown

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

@coveralls
Copy link
Copy Markdown

coveralls commented Mar 2, 2020

Coverage Status

Coverage decreased (-0.03%) to 45.658% when pulling ee5d776 on Ropes:kind/microtask/docs-upgrade-1.5-fix-url into 19c3f5a on cilium:master.

@joestringer joestringer added pending-review release-note/misc This PR makes changes that have no direct user impact. labels Mar 3, 2020
Copy link
Copy Markdown
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.

Thanks for the fix!

I suggest that we just use the latest from the v1.5 branch as they should be pretty stable at this point.

Comment thread Documentation/install/upgrade.rst Outdated
@joestringer
Copy link
Copy Markdown
Member

btw @Ropes if you use git commit -s and your git user / email are configured correctly, then the sign-off will appear in your commit messages automatically so you don't need to manually write that part up.

The broken link was caused by using the 'latest' URL domain and path as
root. \ |SCM_WEB|\/examples/kubernetes/1.10/cilium-pre-flight-with-rm-svc-v2.yaml
Therefore the URL picked up the most recent tags, and post 1.5.12 the
path `/examples/kubernetes/1.X` were removed, so all newly built URLs were broken.

This change makes the URL static to the release path of `1.5.12`. If
there are other options to keep the URL tagged within the `1.5.x` minor
versions; I'm interested in learning about it, but this is a quick fix.

Fixes: cilium#10391

Signed-off-by: Joshua Roppo <joshroppo@gmail.com>
@Ropes Ropes force-pushed the kind/microtask/docs-upgrade-1.5-fix-url branch from e335672 to ee5d776 Compare March 3, 2020 02:49
@Ropes
Copy link
Copy Markdown
Contributor Author

Ropes commented Mar 3, 2020

URL updated to use the v1.5 tag.

Thanks for the git commit -s tip too!

@joestringer
Copy link
Copy Markdown
Member

test-docs-please

@Ropes
Copy link
Copy Markdown
Contributor Author

Ropes commented Mar 3, 2020

Oh joy... test build failed for the reason I outlined on the issue.

Guess I'll make a PR to shave that yak too.

@Ropes
Copy link
Copy Markdown
Contributor Author

Ropes commented Mar 3, 2020

PR up to fix test-docs-please CI pipeline: #10419

@Ropes
Copy link
Copy Markdown
Contributor Author

Ropes commented Mar 3, 2020

test-docs-please

1 similar comment
@pchaigno
Copy link
Copy Markdown
Member

pchaigno commented Mar 3, 2020

test-docs-please

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

Dead link in 1.5 upgrade section on latest docs

6 participants