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

(docs) Broken links in README file #1242

Open
edsoncelio opened this issue Apr 2, 2024 · 3 comments
Open

(docs) Broken links in README file #1242

edsoncelio opened this issue Apr 2, 2024 · 3 comments
Labels
do-not-close Prevents issues from being automatically closed if stale documentation Related to or primarily documentation good first issue Good for newcomers

Comments

@edsoncelio
Copy link

Hi!
I'm testing the project and I identified some broken links (and I haven't seen an issue about it yet) so I'm opening it.
If you point me to the correct links I can open a PR with the correct one :)

The links below:

  • hhttps://github.com/kuberhealthy/kuberhealthy/blob/master/docs/CHECKS.md#khcheck-anatomy
  • https://github.com/kuberhealthy/kuberhealthy/blob/master/docs/CHECK_CREATION.md
  • https://github.com/kuberhealthy/kuberhealthy/blob/master/docs/CHECKS.md
  • https://github.com/kuberhealthy/kuberhealthy/blob/master/docs/KUBERHEALTHY_ADOPTERS.md
@integrii
Copy link
Collaborator

I am actually not sure what happened to these! I tried searching the repo, but several of these weren't there anymore. I know that KUBERHEALTHY_ADOPTERS.md got moved up to the root, which is where we want it. The CHECK_CREATION.md file seems to have disappeared though. Maybe use the last release code for clues?

A PR here would be real helpful.

@integrii integrii added good first issue Good for newcomers documentation Related to or primarily documentation do-not-close Prevents issues from being automatically closed if stale labels Apr 11, 2024
@mauved
Copy link

mauved commented Apr 19, 2024

Looks like docs/CHECKS.md and docs/CHECK_CREATION.md might have been inadvertently removed in #1156.

docs/KUBERHEALTHY_ADOPTERS.md got moved to ADOPTERS.md in #1089 so any lingering references to the old path should be updated.

I can spend a bit of time to take care of this.

@edsoncelio
Copy link
Author

Looks like docs/CHECKS.md and docs/CHECK_CREATION.md might have been inadvertently removed in #1156.

docs/KUBERHEALTHY_ADOPTERS.md got moved to ADOPTERS.md in #1089 so any lingering references to the old path should be updated.

I can spend a bit of time to take care of this.

Thanks!! It will be perfect, at least for the next weeks I'll not be able to work in a PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-close Prevents issues from being automatically closed if stale documentation Related to or primarily documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants