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

Update "About CodeQL" to cover the information needs of security researchers better #17383

Open
wants to merge 3 commits into
base: 12707-felicity-docs-landing
Choose a base branch
from

Conversation

felicitymay
Copy link
Contributor

@felicitymay felicitymay commented Sep 4, 2024

When this article was originally written, it needed to be all things to all people. Now that the CodeQL docs site is firmly focused on security researchers and anyone else who wants to learn how to write CodeQL queries, we can make the content more focused.

These updates aim to answer the following needs of security researchers:

  • Determine if the effort of learning CodeQL is balanced by the additional opportunities to find vulnerabilities
  • Identify a quick way to learn the language.
  • Test my new query so I can report vulnerabilities and get them fixed/get bounty.

In addition, I've added metadata keywords to this article and the new article introduced by:

This are intended to aid discoverability and we'll check the data analytics a month or so after publication to determine whether they are having the expected impact on SEO.

Questions for reviewers

  • Is there anything missing from the revised article?
  • If you're a security researcher, what would you want to see in this article?

@felicitymay felicitymay added the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label Sep 4, 2024
@SiaraMist
Copy link
Contributor

👋 Hey @felicitymay! I'm first responding this week and based on the FR instructions I think a technical review is needed before I put it on the review board? Are you okay to move this forward as needed?

Copy link
Contributor

@subatoi subatoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for these updates! Everything looks good purely from a language point of view.

@@ -39,11 +56,13 @@ CodeQL analysis consists of three steps:
#. Running CodeQL queries against the database
#. Interpreting the query results

For information on the CodeQL toolchain and on running CodeQL to analyze a codebase, see the `CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__, `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code>`__, and `About code scanning with CodeQL <https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql>`__ in GitHub docs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For information on the CodeQL toolchain and on running CodeQL to analyze a codebase, see the `CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__, `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code>`__, and `About code scanning with CodeQL <https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql>`__ in GitHub docs.
For information on the CodeQL toolchain and on running CodeQL to analyze a codebase, see the `CodeQL CLI <https://docs.github.com/en/code-security/codeql-cli>`__, `CodeQL for Visual Studio Code <https://docs.github.com/en/code-security/codeql-for-vs-code>`__, and `About code scanning with CodeQL <https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql>`__ in the GitHub docs.

Super minor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation ready-for-doc-review This PR requires and is ready for review from the GitHub docs team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants