-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Update CodeQL CLI docs articles and links to point to new location on GitHub Docs site #12077
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
Update CodeQL CLI docs articles and links to point to new location on GitHub Docs site #12077
Conversation
How will anchor links be handled? We sometimes provide customers with specific links to anchors/sections within the docs pages. As I understand this PR, following one of those anchored links will now take the reader to the overall page with a redirect notice, but no guidance on how to find the equivalent section in the new page. |
@adityasharad Ah looks like I missed some of those that didn't have the path of the page they were from! We can definitely update that link to point directly to that anchor in the new article, as we kept the same headings as were in the original articles! Let me sweep through and try to find the rest of these anchor links I didn't get 👍 |
@adityasharad I think I got all the anchor links - there were only a few! I found all the anchor links in these migrated articles and searched for them across this repo. Thanks for the question, great catch! 🙇♀️ |
Thanks, that looks like it covers the anchor links within the existing docs. Can we do anything more about existing anchor links that users attempt to access directly (e.g. if they recorded links in their own internal docs for reference)? Perhaps by keeping the table-of-contents list in the redirect pages, with redirect links to each section, rather than just a redirect link to the page as a whole? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for finding and replacing all those links @saritai. I found one more that we should probably update.
Regarding the point about anchors that we've given to users that @adityasharad raises, I think it would be quite a lot of work to update each article with a "fake" TOC. I wonder if this is necessary because the articles on the docs site each have a mini-TOC so users ought to be able to identify the section they need fairly easily, assuming that the heading is an H2.
If we do decide that we need to do something for anchors that you use frequently, perhaps we can make a list of them so that we only add links for headings that are needed?
docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst
Outdated
Show resolved
Hide resolved
….com/github/codeql into codeql-cli-articles-migration-update
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@saritai - thank you for taking the time to add the links to all the anchors in the new location. Hopefully that'll help users find their place easily.
I spot checked some of the TOC links and they all worked perfectly 👍🏻
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
I think this needs a merge back to main, as the post-release merge back has already happened. |
Docs-content issue: https://github.com/github/docs-content/issues/6930
These updates are a follow up to migrating all the articles under "Using the CodeQL CLI" and "CodeQL CLI reference" to the GitHub Docs site.
Changes in this PR:
swift
andgo
directories to update some links in there to point to the new location on GitHub Docs, for convenience.Looks like a number of reviewing groups will be pinged on this - but just know that all of the changes (outside the
codeql-cli
directory) are just updating links to point to GitHub Docs.cc @felicitymay @adityasharad