search

kubernetes-sigs / cluster-api-provider-aws

Kubernetes Cluster API Provider AWS provides consistent deployment and day 2 operations of "self-managed" and EKS Kubernetes clusters on AWS.
http://cluster-api-aws.sigs.k8s.io/
Apache License 2.0
641 stars 566 forks source link

The links in the guide are not working #3453

Open Skarlso opened 2 years ago

Skarlso commented 2 years ago

/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/

k8s-ci-robot commented 2 years ago

@Skarlso: This issue is currently awaiting triage.

If CAPA/CAPI contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
Ankitasw commented 2 years ago

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

Skarlso commented 2 years ago

Yep, will do. :)

sedefsavas commented 2 years ago

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

k8s-ci-robot commented 2 years ago

@sedefsavas: This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-good-first-issue command.

In response to [this](https://github.com/kubernetes-sigs/cluster-api-provider-aws/issues/3453): >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 Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
Skarlso commented 2 years ago

@sedefsavas Oh cool! I literally almost hit submit my issue. :D nice timing. :)

photra commented 2 years ago

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?

k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot commented 1 year ago

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot commented 1 year ago

The issue has been marked as an important bug and triaged. Such issues are automatically marked as frozen when hitting the rotten state to avoid missing important bugs.

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle frozen

Skarlso commented 1 year ago

/lifecycle active

Sajiyah-Salat commented 1 year ago

I think after doing so much activity. The issue is still exist. is it okay if I start working on this by taking your help.

AverageMarcus commented 1 year ago

I did a quick scan of the site, these are the links that are currently broken:

URL Anchor Text Linked From
https://cluster-api-aws.sigs.k8s.io/reference/providers.html provider https://cluster-api-aws.sigs.k8s.io/getting-started.html
https://cluster-api-aws.sigs.k8s.io/reference/glossary.html management cluster https://cluster-api-aws.sigs.k8s.io/getting-started.html
https://cluster-api-aws.sigs.k8s.io/troubleshooting.html Troubleshooting Guide https://cluster-api-aws.sigs.k8s.io/getting-started.html
https://cluster-api-aws.sigs.k8s.io/tasks/experimental-features/experimental-features.html Experimental Features https://cluster-api-aws.sigs.k8s.io/getting-started.html
https://cluster-api-aws.sigs.k8s.io/clusterctl/commands/init.html clusterctl init https://cluster-api-aws.sigs.k8s.io/getting-started.html
https://cluster-api-aws.sigs.k8s.io/clusterctl/commands/generate-cluster.html command https://cluster-api-aws.sigs.k8s.io/getting-started.html
https://cluster-api-aws.sigs.k8s.io/security/pod-security-standards.html Pod Security Standard https://cluster-api-aws.sigs.k8s.io/getting-started.html
https://cluster-api-aws.sigs.k8s.io/clusterctl/developers.html Additional Notes for the Docker provider https://cluster-api-aws.sigs.k8s.io/getting-started.html
https://cluster-api-aws.sigs.k8s.io/clusterctl/overview.html clusterctl https://cluster-api-aws.sigs.k8s.io/getting-started.html
https://cluster-api.sigs.k8s.io/tasks/kubeadm-control-plane.html Upgrading workload clusters https://cluster-api-aws.sigs.k8s.io/topics/images/custom-amis.html
https://cluster-api-aws.sigs.k8s.io/topics/eks/disabling.html Disabling EKS Support https://cluster-api-aws.sigs.k8s.io/topics/eks/index.html
https://cluster-api-aws.sigs.k8s.io/topics/tasks/experimental-features/cluster-class/index.html ClusterClass https://cluster-api-aws.sigs.k8s.io/topics/reference/glossary.html
https://cluster-api-aws.sigs.k8s.io/topics/reference/providers.html Provider Implementations https://cluster-api-aws.sigs.k8s.io/topics/reference/glossary.html
https://cluster-api-aws.sigs.k8s.io/topics/tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.html Implementing Lifecycle Hooks https://cluster-api-aws.sigs.k8s.io/topics/reference/glossary.html
https://cluster-api-aws.sigs.k8s.io/topics/developer/architecture/controllers/multi-tenancy.html Multi-tenancy https://cluster-api-aws.sigs.k8s.io/topics/reference/glossary.html
https://cluster-api-aws.sigs.k8s.io/topics/developer/architecture/controllers/support-multiple-instances.html Support multiple instances https://cluster-api-aws.sigs.k8s.io/topics/reference/glossary.html
https://cluster-api-aws.sigs.k8s.io/topics/tasks/experimental-features/runtime-sdk/index.html Runtime SDK https://cluster-api-aws.sigs.k8s.io/topics/reference/glossary.html
https://cluster-api-aws.sigs.k8s.io/topics/tasks/experimental-features/runtime-sdk/implement-topology-mutation-hook.html Topology Mutation https://cluster-api-aws.sigs.k8s.io/topics/reference/glossary.html
https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/ Kubernetes meta/v1.ObjectMeta https://cluster-api-aws.sigs.k8s.io/crd/index.html
https://cluster-api-aws.sigs.k8s.io/topics/reference/OWNERS repo owners https://cluster-api-aws.sigs.k8s.io/topics/reference/contributing.html
hackeramitkumar commented 1 year ago

@AverageMarcus I would like to work on it.

hackeramitkumar commented 1 year ago

/assign

hackeramitkumar commented 1 year ago

@richardcase, any suggestions for it.

richardcase commented 1 year ago

I think they are a couple of aspects to this:

  1. 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
  2. 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?

hackeramitkumar commented 1 year ago

Sounds good. Thanks @richardcase

hackeramitkumar commented 1 year ago

@Skarlso @richardcase @AverageMarcus I found the cause of error : We are embedding CAPI quick start. But we have kept those files inside topics directory. So when we click on index that all works fine but when we clicks on the links of embedded docs that is showing error.

Let's take a scenerio I am clicking on getting-started link for example - Workload cluster It is redirecting -> https://cluster-api-aws.sigs.k8s.io/reference/glossary.html#workload-cluster But there is noting on this url. Because the relative path is not same for CAPI and CAPA book. And for working fine there should be added topics in between of refrence and BASE URL. But we are actually embedding the book so we can not change this URL. So I only thing we can do is we have to keep all the embedding files in the relative place as they are kept in CAPI.

hackeramitkumar commented 1 year ago

For working these fine I have to bring reference directory one level up.

hackeramitkumar commented 1 year ago

This will be automatically fixed by #4067

ashutosh887 commented 1 year ago

@Skarlso @hackeramitkumar Is this issue resolved If not I would like to work on this

hackeramitkumar commented 1 year ago

@ashutosh887 there is a PR releated to it. After merging that this issue will be resolved automatically.

ashutosh887 commented 1 year ago

Got it... Thanks for clarifying @hackeramitkumar

Skarlso commented 1 year ago

This will be automatically fixed by #4067

Note that for that to happen, you must write Closes #3453 into the description.

k8s-triage-robot commented 9 months ago

This issue is labeled with priority/important-soon but has not been updated in over 90 days, and should be re-triaged. Important-soon issues must be staffed and worked on either currently, or very soon, ideally in time for the next release.

You can:

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted