Merge pull request #17361 from github/12707-felicity-docs-landing

Update the Docs landing page for the CodeQL docs site

docs/codeql/_templates/layout.html

@@ -1,7 +1,7 @@
 {#
     Override alabaster/layout.html template to customize the template
     used to generate the CodeQL documentation.
-    
+
     The classes used in this template are provided by the GitHub Primer https://primer.style/css/.
     The CSS for the primer can be found at https://unpkg.com/@primer/css/dist/primer.css
 
@@ -59,37 +59,34 @@
                 CodeQL resources
                 <div class="dropdown-caret"></div>
             </summary>
-
             <ul class="dropdown-menu dropdown-menu-se dropdown-menu-dark">
-                <li><a class="dropdown-item" href="https://codeql.github.com/docs/codeql-overview">CodeQL overview</a></li>
-                <li class="dropdown-divider" role="separator"></li>
-                <div class="dropdown-header">
-                    CodeQL tools
-                </div>
-                <li><a class="dropdown-item" href="https://codeql.github.com/docs/codeql-for-visual-studio-code">CodeQL for VS Code</a>
-                <li><a class="dropdown-item" href="https://codeql.github.com/docs/codeql-cli">CodeQL CLI</a>
-                </li>
+                <li><a class="dropdown-item" href="codeql-overview">CodeQL overview</a></li>
                 <li class="dropdown-divider" role="separator"></li>
                 <div class="dropdown-header">
                     CodeQL guides
                 </div>
-                <li><a class="dropdown-item" href="https://codeql.github.com/docs/writing-codeql-queries">Writing CodeQL queries</a></li>
-                <li><a class="dropdown-item" href="https://codeql.github.com/docs/codeql-language-guides">CodeQL language guides</a>
+                <li><a class="dropdown-item" href="writing-codeql-queries">Writing CodeQL queries</a></li>
+                <li><a class="dropdown-item" href="codeql-language-guides">CodeQL language guides</a>
                 <li class="dropdown-divider" role="separator"></li>
                 <div class="dropdown-header">
                     Reference docs
                 </div>
-                <li><a class="dropdown-item" href="https://codeql.github.com/docs/ql-language-reference/">QL language
+                <li><a class="dropdown-item" href="ql-language-reference/">QL language
                         reference</a>
-                <li><a class="dropdown-item" href="https://codeql.github.com/codeql-standard-libraries">CodeQL
+                <li><a class="dropdown-item" href="../codeql-standard-libraries">CodeQL
                         standard-libraries</a>
-                <li><a class="dropdown-item" href="https://codeql.github.com/codeql-query-help">CodeQL
+                <li><a class="dropdown-item" href="../codeql-query-help">CodeQL
                         query help</a>
                 <li class="dropdown-divider" role="separator"></li>
                 <div class="dropdown-header">
                     Source files
                 </div>
                 <li><a class="dropdown-item" href="https://github.com/github/codeql">CodeQL repository</a>
+                <li class="dropdown-divider" role="separator"></li>
+                <div class="dropdown-header">
+                    Academic
+                </div>
+                <li><a class="dropdown-item" href="../publications">QL publications</a>
             </ul>
         </details>
 
@@ -165,12 +162,12 @@
             </li>
         </ul>
         <ul class="list-style-none d-flex text-gray">
-            <li class="mr-3">&copy; 
+            <li class="mr-3">&copy;
                 <script type="text/javascript">document.write(new Date().getFullYear());</script> GitHub, Inc.</li>
             <li class="mr-3"><a
-                    href="https://docs.github.com/github/site-policy/github-terms-of-service"
+                    href="https://docs.github.com/site-policy/github-terms/github-terms-of-service"
                     class="link-gray">Terms </a></li>
-            <li><a href="https://docs.github.com/github/site-policy/github-privacy-statement"
+            <li><a href="https://docs.github.com/site-policy/privacy-policies/github-privacy-statement"
                     class="link-gray">Privacy </a></li>
         </ul>
     </div>

docs/codeql/codeql-language-guides/codeql-for-cpp.rst

@@ -28,6 +28,10 @@ Experiment and learn how to write effective and efficient queries for CodeQL dat
 
 -  :doc:`CodeQL library for C and C++ <codeql-library-for-cpp>`: When analyzing C or C++ code, you can use the large collection of classes in the CodeQL library for C and C++.
 
+- `CodeQL CTF: U-Boot Challenge <https://securitylab.github.com/ctf/uboot/>`__: Follow the steps that members of GitHub Security Lab went through to find 13 CWE vulnerabilities in U-Boot.
+
+- `CodeQL CTF: SEGV Hunt <https://securitylab.github.com/ctf/segv/>`__: Follow the steps that members of GitHub Security Lab went through to find unsafe uses of ``alloca`` in the GNU C Library (glibc).
+
 -  :doc:`Functions in C and C++ <functions-in-cpp>`: You can use CodeQL to explore functions in C and C++ code.
 
 -  :doc:`Expressions, types, and statements in C and C++ <expressions-types-and-statements-in-cpp>`: You can use CodeQL to explore expressions, types, and statements in C and C++ code to find, for example, incorrect assignments.

docs/codeql/codeql-language-guides/codeql-for-go.rst

@@ -17,7 +17,9 @@ Experiment and learn how to write effective and efficient queries for CodeQL dat
 
 -  :doc:`CodeQL library for Go <codeql-library-for-go>`: When you're analyzing a Go program, you can make use of the large collection of classes in the CodeQL library for Go.
 
+- `CodeQL CTF: Go and don't return <https://securitylab.github.com/ctf/go-and-dont-return/>`__: Follow the steps that members of GitHub Security Lab went through to find a high severity vulnerability in MinIO, an Amazon S3-compatible object store.
+
 -  :doc:`Abstract syntax tree classes for working with Go programs <abstract-syntax-tree-classes-for-working-with-go-programs>`: CodeQL has a large selection of classes for representing the abstract syntax tree of Go programs.
 
--  :doc:`Modeling data flow in Go libraries <modeling-data-flow-in-go-libraries>`: When analyzing a Go program, CodeQL does not examine the source code for external packages. 
+-  :doc:`Modeling data flow in Go libraries <modeling-data-flow-in-go-libraries>`: When analyzing a Go program, CodeQL does not examine the source code for external packages.
    To track the flow of untrusted data through a library, you can create a model of the library.

docs/codeql/codeql-language-guides/codeql-for-java.rst

@@ -28,7 +28,9 @@ Experiment and learn how to write effective and efficient queries for CodeQL dat
 
 -  :doc:`CodeQL library for Java and Kotlin <codeql-library-for-java>`: When analyzing Java/Kotlin code, you can use the large collection of classes in the CodeQL library for Java/Kotlin.
 
--  :doc:`Analyzing data flow in Java and Kotlin <analyzing-data-flow-in-java>`: You can use CodeQL to track the flow of data through a Java/Kotlin program to its use. 
+-  :doc:`Analyzing data flow in Java and Kotlin <analyzing-data-flow-in-java>`: You can use CodeQL to track the flow of data through a Java/Kotlin program to its use.
+
+- `CodeQL CTF: CodeQL and Chill <https://securitylab.github.com/ctf/codeql-and-chill/>`__: Follow the steps that members of GitHub Security Lab went through to track the flow of tainted data from user-controlled bean properties to custom error messages, and identify the known injection vulnerabilities.
 
 -  :doc:`Java and Kotlin types <types-in-java>`: You can use CodeQL to find out information about data types used in Java/Kotlin code. This allows you to write queries to identify specific type-related issues.
 

docs/codeql/codeql-language-guides/codeql-for-javascript.rst

@@ -25,6 +25,8 @@ Experiment and learn how to write effective and efficient queries for CodeQL dat
 
 -  :doc:`CodeQL library for TypeScript <codeql-library-for-typescript>`: When you're analyzing a TypeScript program, you can make use of the large collection of classes in the CodeQL library for TypeScript.
 
+- `CodeQL CTF: XSS-unsafe jQuery plugins <https://securitylab.github.com/ctf/jquery/>`__: Follow the steps that members of GitHub Security Lab went through to find cross-site scripting vulnerabilities in Bootstrap's jQuery plugins.
+
 -  :doc:`Analyzing data flow in JavaScript and TypeScript <analyzing-data-flow-in-javascript-and-typescript>`: This topic describes how data flow analysis is implemented in the CodeQL libraries for JavaScript/TypeScript and includes examples to help you write your own data flow queries.
 
 -  :doc:`Using flow labels for precise data flow analysis <using-flow-labels-for-precise-data-flow-analysis>`: You can associate flow labels with each value tracked by the flow analysis to determine whether the flow contains potential vulnerabilities.

docs/codeql/codeql-overview/about-codeql.rst

@@ -2,18 +2,33 @@
 
 .. _about-codeql:
 
+.. meta::
+   :description: Introduction to CodeQL, a language and toolchain for code analysis.
+   :keywords: CodeQL, code analysis, CodeQL analysis, security vulnerabilities, variant analysis, resources, tutorials, interactive training, GitHub Security Lab, security researchers, CodeQL databases
+
 About CodeQL
 ============
 
-CodeQL is the analysis engine used by developers to automate security checks, and by
-security researchers to perform variant analysis. 
+CodeQL is a language and toolchain for code analysis. It is designed to allow security researchers to scale their knowledge of a single vulnerability to identify variants of that vulnerability across a wide range of codebases. It is also designed to allow developers to automate security checks and integrate them into their development workflows.
+
+Resources for learning CodeQL
+-----------------------------
+
+- **CodeQL docs site:** contains information on the CodeQL language and libraries, with tutorials and guides to help you learn how to write your own queries.
+
+   - :doc:`CodeQL queries <../writing-codeql-queries/codeql-queries>`: A general, language-neutral overview of the key components of a query.
+
+   - :doc:`QL tutorials <../writing-codeql-queries/ql-tutorials>`: Solve puzzles to learn the basics of QL before you analyze code with CodeQL. The tutorials teach you how to write queries and introduce you to key logic concepts along the way.
+
+   - :doc:`CodeQL language guides <../codeql-language-guides/index>`: Guides to the CodeQL libraries for each language, including the classes and predicates that are available for use in queries, with worked examples.
 
-In CodeQL, code is treated like data. Security vulnerabilities, bugs, 
-and other errors are modeled as queries that can be executed against databases
-extracted from code. You can run the standard CodeQL queries, written by GitHub
-researchers and community contributors, or write your own to use in custom
-analyses. Queries that find potential bugs highlight the result directly in the
-source file.
+- **GitHub Security Lab:** is GitHub's own security research team. They've created a range of resources to help you learn how to use CodeQL to find security vulnerabilities in real-world codebases.
+
+   - `Secure code game <https://github.com/skills/secure-code-game>`__: A series of interactive sessions that guide you from finding insecure code patterns manually, through to using CodeQL to find insecure code patterns automatically.
+
+   - `Security Lab CTF <https://securitylab.github.com/ctf/>`__: A series of Capture the Flag (CTF) challenges that are designed to help you learn how to use CodeQL to find security vulnerabilities in real-world codebases.
+
+   - `Security Lab blog <https://github.blog/tag/github-security-lab/>`__: A series of blog posts that describe how CodeQL is used by security researchers to find security vulnerabilities in real-world codebases.
 
 About variant analysis
 ----------------------
@@ -30,6 +45,8 @@ queries. Then, develop or iterate over the query to automatically find logical
 variants of the same bug that could be missed using traditional manual
 techniques.
 
+When you have a query that finds variants of a vulnerability, you can use multi-repository variant analysis to run that query across a large number of codebases, and identify all of the places where that vulnerability exists. For more information, see `Running CodeQL queries at scale with multi-repository variant analysis <https://docs.github.com/en/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis>`__ in the GitHub docs.
+
 CodeQL analysis
 ---------------
 
@@ -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 the GitHub docs.
+
 Database creation
 ~~~~~~~~~~~~~~~~~
 
 To create a database, CodeQL first extracts a single relational representation
-of each source file in the codebase. 
+of each source file in the codebase.
 
 For compiled languages, extraction works by monitoring the normal build process.
 Each time a compiler is invoked to process a source file, a copy of that file is
@@ -52,7 +71,7 @@ syntactic data about the abstract syntax tree and semantic data about name
 binding and type information.
 
 For interpreted languages, the extractor runs directly on the source code,
-resolving dependencies to give an accurate representation of the codebase. 
+resolving dependencies to give an accurate representation of the codebase.
 
 There is one :ref:`extractor <extractor>` for each language supported by CodeQL
 to ensure that the extraction process is as accurate as possible. For
@@ -72,7 +91,7 @@ against it. CodeQL queries are written in a specially-designed object-oriented
 query language called QL. You can run the queries checked out from the CodeQL
 repo (or custom queries that you've written yourself) using the `CodeQL
 for VS Code extension <https://docs.github.com/en/code-security/codeql-for-vs-code/>`__ or the `CodeQL CLI
-<https://docs.github.com/en/code-security/codeql-cli>`__. For more information about queries, see ":ref:`About CodeQL queries <about-codeql-queries>`." 
+<https://docs.github.com/en/code-security/codeql-cli>`__. For more information about queries, see ":ref:`About CodeQL queries <about-codeql-queries>`."
 
 .. _interpret-query-results:
 
@@ -95,7 +114,7 @@ code.
 Following interpretation, results are output for code review and triaging. In
 CodeQL for Visual Studio Code, interpreted query results are automatically
 displayed in the source code. Results generated by the CodeQL CLI can be output
-into a number of different formats for use with different tools. 
+into a number of different formats for use with different tools.
 
 
 About CodeQL databases
@@ -104,7 +123,7 @@ About CodeQL databases
 CodeQL databases contain queryable data extracted from a codebase, for a single
 language at a particular point in time. The database contains a full,
 hierarchical representation of the code, including a representation of the
-abstract syntax tree, the data flow graph, and the control flow graph. 
+abstract syntax tree, the data flow graph, and the control flow graph.
 
 Each language has its own unique database schema that defines the relations used
 to create a database. The schema provides an interface between the initial
@@ -114,13 +133,13 @@ every language construct.
 
 For each language, the CodeQL libraries define classes to provide a layer of
 abstraction over the database tables. This provides an object-oriented view of
-the data which makes it easier to write queries. 
+the data which makes it easier to write queries.
 
 For example, in a CodeQL database for a Java program, two key tables are:
 
 -  The ``expressions`` table containing a row for every single expression in the
-   source code that was analyzed during the build process. 
--  The ``statements`` table containing a row for every single statement in the 
+   source code that was analyzed during the build process.
+-  The ``statements`` table containing a row for every single statement in the
    source code that was analyzed during the build process.
 
 The CodeQL library defines classes to provide a layer of abstraction over each