cluster-api-provider-aws: The links in the guide are not working

/kind bug

What steps did you take and what happened: [A clear and concise description of what the bug is.]

https://cluster-api-aws.sigs.k8s.io/getting-started.html?highlight=worker-machine-count#create-your-first-workload-cluster -> here click on workload cluster -> https://cluster-api-aws.sigs.k8s.io/reference/glossary.html#workload-cluster

All of these links in the guide which should lead to somewhere describing the thing I clicked are leading to a 404 page.

Kubernetes Cluster API Provider AWS
 
[Document not found (404)](https://cluster-api-aws.sigs.k8s.io/#document-not-found-404)
This URL is invalid, sorry. Please use the navigation bar or search to continue.

What did you expect to happen:

To lead to somewhere describing the thing.

Anything else you would like to add: [Miscellaneous information that will assist in solving the issue.]

Environment:

Documentation under https://cluster-api-aws.sigs.k8s.io/

About this issue

Original URL
State: open
Created 2 years ago
Comments: 25 (19 by maintainers)

Commits related to this issue

Added files to fix broken links mentioned in issue #3453 and #3575 — committed to MaheshMoholkar/cluster-api-provider-aws by MaheshMoholkar 2 years ago
Revert "Added files to fix broken links mentioned in issue #3453 and #3575" This reverts commit 17c9568d6c9420347022791b445c0bce053f8864. — committed to MaheshMoholkar/cluster-api-provider-aws by MaheshMoholkar 2 years ago

Most upvoted comments

@AverageMarcus I would like to work on it.

hackeramitkumar on Feb 4, 2023

I think they are a couple of aspects to this:

Automatically checking links in the markdown docs. Upstream CAPI dues this via GitHub actions weekly and via PR: https://github.com/kubernetes-sigs/cluster-api/blob/main/.github/workflows/lint-docs-pr.yaml
For any missing links initially we need to work out where it should point. If you get this list and see if you can find a suitable link. For any that aren’t obvious the maintainers/reviewers can help.

How does that sound?

richardcase on Feb 4, 2023

While reproducing this bug, I noticed that there are many more instances of links not working.

Some broken links currently follow this format: https://cluster-api-aws.sigs.k8s.io/reference/[file].html (file here includes glossary, providers,…)

But they should follow this format in order to work: https://cluster-api-aws.sigs.k8s.io/topics/reference/[file].html (Visiting this link correctly locates the page raised in this issue).

I traced it down to getting-started.md, and found our relative paths are different from the inherited docs under kubernetes-sigs/cluster-api, which caused links to break.

Should we move the reference folder up in the directory to fix this issue?

photra on May 19, 2022

@sedefsavas Oh cool! I literally almost hit submit my issue. 😄 nice timing. 😃

Skarlso on Apr 29, 2022

It is working in cluster-api book:https://cluster-api.sigs.k8s.io/reference/glossary.html#workload-cluster, so we need to fix it here.

/triage-accepted /good-first-issue

sedefsavas on Apr 29, 2022

Yep, will do. 😃

Skarlso on Apr 29, 2022

@Skarlso Thank you for raising this issue. Since this particular doc is inherited from cluster-api project, do you mind raising this issue there?

Ankitasw on Apr 29, 2022