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

📖 Added CAPA own getting-started instead of using CAPI embedded getting-started #4082

Closed
wants to merge 1 commit into from

Conversation

hackeramitkumar
Copy link
Member

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:

  • squashed commits
  • includes documentation
  • adds unit tests
  • adds or updates e2e tests

Release note:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 20, 2023
@k8s-ci-robot
Copy link
Contributor

[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 k8s-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Feb 20, 2023
@hackeramitkumar hackeramitkumar changed the title [docs]: Added CAPA own getting-started instead of using CAPI embedded getting-started 📖 Added CAPA own getting-started instead of using CAPI embedded getting-started Feb 20, 2023
See the [clusterctl] documentation for more detail about clusterctl supported actions.

<!-- links -->
[Experimental Features]: https://cluster-api.sigs.k8s.io/tasks/experimental-features/experimental-features.html
Copy link
Member

Choose a reason for hiding this comment

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

I think we don't need other providers links here.

Copy link
Member Author

@hackeramitkumar hackeramitkumar Feb 20, 2023

Choose a reason for hiding this comment

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

Sure I will remove the unnecessary links from here.
thanks for pointing out it.

docs/book/src/getting-started.md Outdated Show resolved Hide resolved
docs/book/src/getting-started.md Show resolved Hide resolved
Copy link
Member

@Ankitasw Ankitasw left a comment

Choose a reason for hiding this comment

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

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

@hackeramitkumar
Copy link
Member Author

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?

@Ankitasw
Copy link
Member

@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?

@hackeramitkumar
Copy link
Member Author

@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 ).

@Ankitasw
Copy link
Member

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
Copy link
Member

Hey @hackeramitkumar do you need any help here?

@hackeramitkumar
Copy link
Member Author

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

@Ankitasw
Copy link
Member

No hurry, take your time 😄

@hackeramitkumar
Copy link
Member Author

hackeramitkumar commented Mar 26, 2023

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

[management cluster]: ./topics/reference/glossary.md
[KubeVirt]: https://kubevirt.io/
[provider components]: ./topics/reference/glossary.md
[workload cluster]: ./topics/reference/glossary.md
Copy link
Member

@Ankitasw Ankitasw Mar 28, 2023

Choose a reason for hiding this comment

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

This link still doesn't work, could you check it?

@Ankitasw
Copy link
Member

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

@nrb
Copy link
Contributor

nrb commented Sep 21, 2023

@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.

@k8s-triage-robot
Copy link

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-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 21, 2024
@k8s-triage-robot
Copy link

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-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Feb 20, 2024
@k8s-ci-robot
Copy link
Contributor

@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 6f6f951 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-triage-robot
Copy link

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-ci-robot
Copy link
Contributor

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. needs-priority release-note-none Denotes a PR that doesn't merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create our own "getting started" etc instead of importing CAPI docs
5 participants