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

Fix broken API anchor links #1634

Merged
merged 1 commit into from
Aug 24, 2023
Merged

Fix broken API anchor links #1634

merged 1 commit into from
Aug 24, 2023

Conversation

kingdonb
Copy link
Member

These were obscured in the pre-release checks because some structural changes to the API docs hadn't been merged yet.

We can merge these changes straight away, or wait a few minutes and I'll have more corrections based on the reporting output. I think that most (>50%) of the errors I'm seeing are actually properly redirected, so it's taking a bit of effort to see whether each bad link on the report is a bogon or a valid issue to follow up. Should be over in a few minutes though.

@kingdonb
Copy link
Member Author

kingdonb commented Aug 24, 2023

The remaining "bad links" in the report are now corralled to two types: 1. the calendar link on the main page which has for some reason ZgotmplZ in it, (I think we made up some fields and the template errors out) and 2. blog links which refer to the old singular API style, that is properly redirected but not canonicalized. (and 3. this one: fluxcd/image-automation-controller#578)

Since I think we should update the link checker to follow redirects and not report them as errors, I'm going to leave those un-canonicalized for now, they don't hurt anything. (Here are the examples I'm talking about)

<style type="text/css"></style>

link_source bad_link
https://fluxcd.io/blog/2021/09/september-2021-update/ https://fluxcd.io/flux/components/notification/provider/#writing-a-provider-spec
https://fluxcd.io/blog/2021/11/december-update/ https://fluxcd.io/flux/components/notification/provider/#slack
https://fluxcd.io/blog/2022/01/january-update/ https://fluxcd.io/flux/components/kustomize/kustomization/#hashicorp-vault
https://fluxcd.io/blog/2022/03/february-update/ https://fluxcd.io/flux/components/notification/provider/#grafana
https://fluxcd.io/blog/2022/03/february-update/ https://fluxcd.io/flux/components/notification/alert/#example
https://fluxcd.io/blog/2022/03/february-update/ https://fluxcd.io/flux/components/kustomize/kustomization/#post-build-variable-substitution
https://fluxcd.io/blog/2022/04/march-update/ https://fluxcd.io/flux/components/kustomize/kustomization/#azure-key-vault-secret-entry
https://fluxcd.io/blog/2022/07/june-2022-update/ https://fluxcd.io/flux/components/notification/provider/#setting-up-the-github-dispatch-provider
https://fluxcd.io/blog/2022/08/manage-kyverno-policies-as-ocirepositories/ https://fluxcd.io/flux/components/kustomize/kustomization/#patches
https://fluxcd.io/blog/2022/08/manage-kyverno-policies-as-ocirepositories/ https://fluxcd.io/flux/components/kustomize/kustomization/#dependencies

If you follow these links in a browser or with redirects following enabled, then you can see they all work. I'll update the link checker to not flag them as errors anymore, before we merge it in #1630.

These were obscured in the pre-release checks because some structural
changes to the API docs hadn't been merged yet.

Fix some to canonicalized urls

Some are not technically errors since the redirect is in place, but the
mismatch upsets the link checker's caching strategy so let's fix it.

Signed-off-by: Kingdon Barrett <[email protected]>
@kingdonb kingdonb force-pushed the fix-helm-operator-migration branch from 65a87af to fabe6e7 Compare August 24, 2023 14:51
@kingdonb kingdonb marked this pull request as ready for review August 24, 2023 14:51
Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

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

LGTM

Thanks @kingdonb 🏅

@stefanprodan stefanprodan merged commit 87d9f0d into main Aug 24, 2023
@stefanprodan stefanprodan deleted the fix-helm-operator-migration branch August 24, 2023 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants