-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Update links to CodeQL manual in the codeql.github.com site #12967
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
Conversation
Make CodeQL CLI a single item in the side navigation
@@ -4,15 +4,15 @@ | |||
<https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli#including-query-metadata>`__. You can also execute queries using the following |
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.
Is this file still being used? I can't find any references to it in github/codeql.
@@ -4,15 +4,15 @@ | |||
<https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli#including-query-metadata>`__. You can also execute queries using the following | |||
plumbing-level subcommands: | |||
|
|||
- `database run-queries <../manual/database-run-queries>`__, which | |||
- `database run-queries <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-manual/database-run-queries>`__, which | |||
outputs non-interpreted results in an intermediate binary format called | |||
:ref:`BQRS <bqrs-file>`. |
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.
Is this ref
correct? I'm not sure how rst resolves this.
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.
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.
I think it's correct. It's modelled on the link in line 4. However, if the file isn't being used any more, it sounds as if it might be better to delete it.
Having checked, it was used in a CodeQL CLI article that's now moved to docs.github.com.
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! Looks good. I verified that all of the links are correct.
@@ -4,15 +4,15 @@ | |||
<https://docs.github.com/en/code-security/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli#including-query-metadata>`__. You can also execute queries using the following | |||
plumbing-level subcommands: | |||
|
|||
- `database run-queries <../manual/database-run-queries>`__, which | |||
- `database run-queries <https://docs.github.com/en/code-security/codeql-cli/codeql-cli-manual/database-run-queries>`__, which | |||
outputs non-interpreted results in an intermediate binary format called | |||
:ref:`BQRS <bqrs-file>`. |
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.
In addition to updating some links, this will also make CodeQL CLI a single, unexpandable item in the side navigation.
This is follow-up work after the migration of the CodeQL CLI manual to CodeQL CLI commands manual. We're also adding redirects from the old articles to the location separately.