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

Link to PVC API reference from concept page nav #48334

Open
sftim opened this issue Oct 14, 2024 · 4 comments
Open

Link to PVC API reference from concept page nav #48334

sftim opened this issue Oct 14, 2024 · 4 comments
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language priority/backlog Higher priority than priority/awaiting-more-evidence. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@sftim
Copy link
Contributor

sftim commented Oct 14, 2024

This is a Feature Request

What would you like to be added
Add a link to the right hand navigation of
https://kubernetes.io/docs/concepts/storage/persistent-volumes/ that links to the API reference for PersistentVolumeClaim.

The way to do this is to edit the single item array that starts with

and add a second item, for PersistentVolumeClaim. You can preview your changes locally to verify that you made the right change.

Why is this needed
https://kubernetes.io/docs/concepts/storage/persistent-volumes/ links to the API reference for PersistentVolume, but not for PersistentVolumeClaim. The page documents both things.

Comments
/language en
/help
/priority backlog
/triage accepted

@sftim sftim added the kind/feature Categorizes issue or PR as related to a new feature. label Oct 14, 2024
@k8s-ci-robot
Copy link
Contributor

@sftim:
This request has been marked as needing help from a contributor.

Guidelines

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

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

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-help command.

In response to this:

This is a Feature Request

What would you like to be added
Add a link to the right hand navigation of
https://kubernetes.io/docs/concepts/storage/persistent-volumes/ that links to the API reference for PersistentVolumeClaim.

The way to do this is to edit the single item array that starts with

and add a second item, for PersistentVolumeClaim. You can preview your changes locally to verify that you made the right change.

Why is this needed
https://kubernetes.io/docs/concepts/storage/persistent-volumes/ links to the API reference for PersistentVolume, but not for PersistentVolumeClaim. The page documents both things.

Comments
/language en
/help
/priority backlog
/triage accepted

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. priority/backlog Higher priority than priority/awaiting-more-evidence. triage/accepted Indicates an issue or PR is ready to be actively worked on. labels Oct 14, 2024
@sftim
Copy link
Contributor Author

sftim commented Oct 14, 2024

/good-first-issue

@k8s-ci-robot
Copy link
Contributor

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

Guidelines

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

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

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:

/good-first-issue

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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Oct 14, 2024
@dev-johnn
Copy link
Contributor

I want to try to implement this.

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. language/en Issues or PRs related to English language priority/backlog Higher priority than priority/awaiting-more-evidence. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

3 participants