cluster-api-provider-aws icon indicating copy to clipboard operation
cluster-api-provider-aws copied to clipboard

:book: Added CAPA own getting-started instead of using CAPI embedded getting-started

Open hackeramitkumar opened this issue 2 years ago • 14 comments
trafficstars

What type of PR is this? /kind documentation

What this PR does / why we need it: We are using CAPI embedded getting started. But that are causing many broken links and also have extra informations that are not required for CAPA users. So I have added CAPA own getting-started.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged): Fixes #4067

Special notes for your reviewer:

Checklist:

  • [X] squashed commits
  • [X] includes documentation
  • [ ] adds unit tests
  • [ ] adds or updates e2e tests

Release note:

NONE

hackeramitkumar avatar Feb 20 '23 07:02 hackeramitkumar

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Once this PR has been reviewed and has the lgtm label, please assign vincepri for approval. For more information see the Kubernetes Code Review Process.

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

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

k8s-ci-robot avatar Feb 20 '23 07:02 k8s-ci-robot

Could you please fix below error in md-lint?

Error: src/getting-started.md: link "./topics/reference/glossary.md#bootstrap-cluster" points to a non-existing slug

@Ankitasw I have mentioned above 3 approaches. By these all 3 approaches md-lint error will be gone. Can you tell me , which approach I should follow?

hackeramitkumar avatar Feb 27 '23 15:02 hackeramitkumar

@Ankitasw I have mentioned above 3 approaches. By these all 3 approaches md-lint error will be gone. Can you tell me , which approach I should follow?

I miss to find the approaches, could you paste it here again?

Ankitasw avatar Feb 27 '23 15:02 Ankitasw

@Ankitasw I have mentioned above 3 approaches. By these all 3 approaches md-lint error will be gone. Can you tell me , which approach I should follow?

I miss to find the approaches, could you paste it here again?

Here we are using embeded glosary.md. So when we are doing glossary.md#bootstrap-cluster then the workflow are not able to identify it so it is showing error because in CAPA glosary there is nothing related to #bootstrap-cluster. So for fixing this issue there are following ways -

  1. We can ignore these checks and merge the PR.
  2. We can remove these navigation to particular defination and navigate them to only glosary.md.
  3. We should add our own glosary.md for CAPA. ( But I do not think it will be good idea ).

hackeramitkumar avatar Feb 27 '23 15:02 hackeramitkumar

So the first one is not an option for us, we cannot ignore this error as it will fail for other PRs as well. 3rd one is cumbersome. I am not sure if I understand the 2nd option. Which navigation can be removed, could you please point in the doc.

Ankitasw avatar Feb 27 '23 16:02 Ankitasw

Hey @hackeramitkumar do you need any help here?

Ankitasw avatar Mar 25 '23 14:03 Ankitasw

@Ankitasw thanks for asking. I have almost done it. I will complete it till tomorrow.

hackeramitkumar avatar Mar 25 '23 15:03 hackeramitkumar

No hurry, take your time 😄

Ankitasw avatar Mar 25 '23 15:03 Ankitasw

@Ankitasw please review it. And let me know if any changes are required...

hackeramitkumar avatar Mar 26 '23 23:03 hackeramitkumar

@hackeramitkumar do you need any support to continue this PR?

Ankitasw avatar May 26 '23 05:05 Ankitasw

@hackeramitkumar Are you still able to continue with this PR?

Also, could you add Closes: #3453 to the description? You mentioned that this change would fix those issues, as well.

nrb avatar Sep 21 '23 20:09 nrb

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

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

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

/lifecycle stale

k8s-triage-robot avatar Jan 21 '24 20:01 k8s-triage-robot

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

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle rotten
  • Close this PR with /close
  • Offer to help out with Issue Triage

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

/lifecycle rotten

k8s-triage-robot avatar Feb 20 '24 20:02 k8s-triage-robot

@hackeramitkumar: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-cluster-api-provider-aws-build-docker 6f6f951667e41c27a313deb95f0ff757d612a091 link true /test pull-cluster-api-provider-aws-build-docker

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

k8s-ci-robot avatar Feb 29 '24 12:02 k8s-ci-robot

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

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close

k8s-triage-robot avatar Mar 30 '24 12:03 k8s-triage-robot

@k8s-triage-robot: Closed this PR.

In response to this:

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

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Reopen this PR with /reopen
  • Mark this PR as fresh with /remove-lifecycle rotten
  • Offer to help out with Issue Triage

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

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

k8s-ci-robot avatar Mar 30 '24 12:03 k8s-ci-robot