Skip to content

Broaden redirect for "latest/tasks" path on old docs site#754

Merged
jetstack-bot merged 1 commit intocert-manager:masterfrom
SgtCoDFish:k8sdocslink
Nov 10, 2021
Merged

Broaden redirect for "latest/tasks" path on old docs site#754
jetstack-bot merged 1 commit intocert-manager:masterfrom
SgtCoDFish:k8sdocslink

Conversation

@SgtCoDFish
Copy link
Member

This is intended to fix a broken link under https://kubernetes.io/docs/tasks/administer-cluster/kubeadm/kubeadm-certs/#set-up-a-signer which points to https://docs.cert-manager.io/en/latest/tasks/issuers/setup-ca.html

Thanks to Jon for reporting!

/kind cleanup

@jetstack-bot jetstack-bot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. labels Nov 10, 2021
@netlify
Copy link

netlify bot commented Nov 10, 2021

✔️ Deploy Preview for cert-manager-website ready!

🔨 Explore the source changes: 37f3660

🔍 Inspect the deploy log: https://app.netlify.com/sites/cert-manager-website/deploys/618bb1417e9259000758c453

😎 Browse the preview: https://deploy-preview-754--cert-manager-website.netlify.app

@jetstack-bot jetstack-bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Nov 10, 2021
@james-w
Copy link
Contributor

james-w commented Nov 10, 2021

I think this will mean that that URL redirects to docs/configuration/setup-ca.html but that is a 404. Should it be docs/configuration/ca/ instead?

_redirects Outdated
https://docs.cert-manager.io/en/latest/getting-started/index.html https://cert-manager.io/docs/tutorials/
https://docs.cert-manager.io/en/latest/tutorials/acme/index.html https://cert-manager.io/docs/tutorials/
https://docs.cert-manager.io/en/latest/tasks/issuers/index.html https://cert-manager.io/docs/configuration/
https://docs.cert-manager.io/en/latest/tasks/issuers/* https://cert-manager.io/docs/configuration/
Copy link
Contributor

Choose a reason for hiding this comment

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

you'll need to add the :splat if you wish for the path to be added to the redirected URL - ie

https://docs.cert-manager.io/en/latest/tasks/issuers/* https://cert-manager.io/docs/configuration/:splat

Copy link
Member Author

Choose a reason for hiding this comment

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

That wasn't my intention, no. There's no obvious mapping of the names of individual html pages on the docs.cert-manager.io site to pages under https://cert-manager.io/docs/ - I think using :splat would be the incorrect behaviour here?

@SgtCoDFish
Copy link
Member Author

I think this will mean that that URL redirects to docs/configuration/setup-ca.html but that is a 404. Should it be docs/configuration/ca/ instead?

I wouldn't have expected that 🤔 I would've thought for the redirect to be to docs/configuration/setup-ca.html to happen the rule would've had to be:

https://docs.cert-manager.io/en/latest/tasks/issuers/* https://cert-manager.io/docs/configuration/:splat

E.g. in this line we already have the redirect works as I expect. But I don't know this area well and I don't really know of a good way to test this before merging.

My instinct would be to merge as-is and then I can quickly raise a new PR to fix if it's not correct

@james-w
Copy link
Contributor

james-w commented Nov 10, 2021

I think this will mean that that URL redirects to docs/configuration/setup-ca.html but that is a 404. Should it be docs/configuration/ca/ instead?

I wouldn't have expected that 🤔 I would've thought for the redirect to be to docs/configuration/setup-ca.html to happen the rule would've had to be:

https://docs.cert-manager.io/en/latest/tasks/issuers/* https://cert-manager.io/docs/configuration/:splat

E.g. in this line we already have the redirect works as I expect. But I don't know this area well and I don't really know of a good way to test this before merging.

My instinct would be to merge as-is and then I can quickly raise a new PR to fix if it's not correct

Ah, I misunderstood the syntax, sorry.

This redirect therefore takes the link to configure a CA issuer and just points to the config section, do we want
to point to the new CA issuer docs?

Copy link
Member

@jakexks jakexks left a comment

Choose a reason for hiding this comment

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

/lgtm
/hold

I think we should merge this, (but it's always a bit scary as you can't test it)

We should also update the actual Kubernetes website.

@jetstack-bot jetstack-bot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm Indicates that a PR is ready to be merged. labels Nov 10, 2021
@jetstack-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jakexks, SgtCoDFish

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

The pull request process is described here

Details Needs approval from an approver in each of these files:

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

@SgtCoDFish
Copy link
Member Author

This redirect therefore takes the link to configure a CA issuer and just points to the config section, do we want
to point to the new CA issuer docs?

That's a fair point - we can do better with the redirects. From looking at an old wayback machine crawl I can see these pages are guides for setting up issuers - I'll add redirects for each individual issuer.

these are based on a wayback machine crawl of the old site

Signed-off-by: Ashley Davis <ashley.davis@jetstack.io>
@jetstack-bot jetstack-bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed lgtm Indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 10, 2021
Copy link
Member

@jakexks jakexks left a comment

Choose a reason for hiding this comment

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

/lgtm

@jetstack-bot jetstack-bot added the lgtm Indicates that a PR is ready to be merged. label Nov 10, 2021
@SgtCoDFish
Copy link
Member Author

/unhold

(we'll see if this gets us to a happy place; I can easily raise another if needed)

@jetstack-bot jetstack-bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 10, 2021
@jetstack-bot jetstack-bot merged commit 4beace3 into cert-manager:master Nov 10, 2021
@SgtCoDFish SgtCoDFish deleted the k8sdocslink branch November 10, 2021 13:46
@SgtCoDFish
Copy link
Member Author

SgtCoDFish commented Nov 10, 2021

... it redirects to https://cert-manager.io/docs/en/latest/tasks/issuers/setup-ca.html now, flying in the face of all logic I'd expected 😂

EDIT: maybe not, looks like it took a little time to propagate correctly inside netlify. https://docs.cert-manager.io/en/latest/tasks/issuers/setup-ca.html is fixed now.

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

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants