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

"Available Plugins" mislinked in documentation. #3138

Closed
ghost opened this issue Dec 27, 2022 · 4 comments · Fixed by #3140
Closed

"Available Plugins" mislinked in documentation. #3138

ghost opened this issue Dec 27, 2022 · 4 comments · Fixed by #3140
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/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation.

Comments

@ghost
Copy link

ghost commented Dec 27, 2022

I'm not really sure what to do about this, because there is clearly a bug with how the markdown is being rendered on Github as well as the Git book.

When reading through the documentation about plugins, I found that the generated documentation has a broken link here: https://github.com/kubernetes-sigs/kubebuilder/blob/master/docs/book/src/plugins/creating-plugins.md?plain=1#L24

The markdown is as follows:

Kubebuilder provides a set of plugins to scaffold the projects, to help you extend and re-use its implementation to provide additional features.
For further information see [Available Plugins][available-plugins].

The rendered output seen here on github and the git book here links to a creating a pull request in Github:

Kubebuilder provides a set of plugins to scaffold the projects, to help you extend and re-use its implementation to provide additional features.
For further information see <a href="https://github.com/kubernetes-sigs/kubebuilder/pull/available-plugins.md">Available Plugins</a>.
@camilamacedo86
Copy link
Member

Hi @protosam,

Thank you. It is bug and we need to fix the link:

It should be relative to the others that can be found in the docs and should be for the page: https://book.kubebuilder.io/plugins/available-plugins.html

Your help is very welcome. Please, feel free to push a PR to fix this one.

Thank you.

@camilamacedo86 camilamacedo86 added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation. labels Dec 28, 2022
@tan-i-ham
Copy link
Contributor

Hi @protosam @camilamacedo86,
May I work on this issue?

@ghost
Copy link
Author

ghost commented Dec 30, 2022

I think the CLA would be a blocker for me making a commit, so feel free to work on this @tan-i-ham.

@tan-i-ham
Copy link
Contributor

/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/bug Categorizes issue or PR as related to a bug. kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants