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

Broken Link: Github search links are broken in documentation #13059

Closed
ashutoshdubey133 opened this issue May 12, 2023 · 6 comments
Closed

Broken Link: Github search links are broken in documentation #13059

ashutoshdubey133 opened this issue May 12, 2023 · 6 comments

Comments

@ashutoshdubey133
Copy link

ashutoshdubey133 commented May 12, 2023

Github search links in documentation such as:

  1. https://checkstyle.org/config_coding.html#FallThrough_Example_of_Usage
  2. https://checkstyle.org/config_coding.html#FallThrough_Violation_Messages

image

These are broken because they use "filename" which is not a supported qualifier in the new github search.
For a list of supported qualifers - https://docs.github.com/en/search-github/github-code-search/understanding-github-code-search-syntax

We would have to replace "filename" with "path" qualifer and use regex.

@romani
Copy link
Member

romani commented May 12, 2023

@ashutoshdubey133 , if know how to fix, please send pull request.
whole web site is at https://github.com/checkstyle/checkstyle/tree/master/src/xdocs

@rnveach
Copy link
Member

rnveach commented May 12, 2023

Image and link shows suggestion. Suggestion worked for me and looks similar to old behavior.

@Vyom-Yadav
Copy link
Member

This is similar to #12905.
I opened an issue on GH repo regarding this github/docs#24666

@Andromeda227799
Copy link

I am on It

Andromeda227799 pushed a commit to Andromeda227799/checkstyle that referenced this issue May 23, 2023
Andromeda227799 pushed a commit to Andromeda227799/checkstyle that referenced this issue May 23, 2023
…n documentation

Issue checkstyle#13059: Broken Link: Github search links are broken in documentation
Andromeda227799 pushed a commit to Andromeda227799/checkstyle that referenced this issue May 23, 2023
Andromeda227799 pushed a commit to Andromeda227799/checkstyle that referenced this issue May 23, 2023
Andromeda227799 pushed a commit to Andromeda227799/checkstyle that referenced this issue May 23, 2023
@romani romani closed this as completed May 24, 2023
@github-actions github-actions bot added this to the 10.12.0 milestone May 24, 2023
@romani
Copy link
Member

romani commented May 24, 2023

Fix is merged

@Andromeda227799
Copy link

@romani can we close #12905 also, since it looks like a similar issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants