From 75b0676c9598d04447d485e689f32acec39f3c6a Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Fri, 3 Feb 2023 13:37:53 -0500 Subject: [PATCH] Add tocs with links to deprecated articles --- docs/codeql/codeql-cli/about-codeql-packs.rst | 18 +++++++++++++- .../codeql-cli/about-codeql-workspaces.rst | 8 ++++++- .../codeql-cli/about-the-codeql-cli.rst | 6 ++++- ...nalyzing-databases-with-the-codeql-cli.rst | 18 +++++++++++++- ...creating-and-working-with-codeql-packs.rst | 10 +++++++- .../codeql-cli/creating-codeql-databases.rst | 17 ++++++++++++- .../creating-codeql-query-suites.rst | 14 ++++++++++- docs/codeql/codeql-cli/exit-codes.rst | 2 +- docs/codeql/codeql-cli/extractor-options.rst | 8 ++++++- .../getting-started-with-the-codeql-cli.rst | 18 +++++++++++++- .../publishing-and-using-codeql-packs.rst | 12 +++++++++- .../codeql-cli/query-reference-files.rst | 7 +++++- docs/codeql/codeql-cli/sarif-output.rst | 24 ++++++++++++++++++- ...options-in-a-codeql-configuration-file.rst | 7 +++++- .../codeql-cli/testing-custom-queries.rst | 12 +++++++++- .../codeql-cli/testing-query-help-files.rst | 8 ++++++- ...ing-custom-queries-with-the-codeql-cli.rst | 9 ++++++- .../codeql-cli-migration-toc-note.rst | 1 + 18 files changed, 182 insertions(+), 17 deletions(-) create mode 100644 docs/codeql/reusables/codeql-cli-migration-toc-note.rst diff --git a/docs/codeql/codeql-cli/about-codeql-packs.rst b/docs/codeql/codeql-cli/about-codeql-packs.rst index ec18563f5f9f..5aa0462e85d6 100644 --- a/docs/codeql/codeql-cli/about-codeql-packs.rst +++ b/docs/codeql/codeql-cli/about-codeql-packs.rst @@ -6,4 +6,20 @@ About CodeQL packs .. pull-quote:: This article was moved to "`About CodeQL packs `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `CodeQL pack structure `__ + * `About published packs `__ +* `About qlpack.yml files `__ + * `qlpack.yml properties `__ +* `About codeql-pack.lock.yml files `__ +* `Examples of custom CodeQL packs `__ + * `CodeQL packs for custom libraries `__ + * `CodeQL packs for custom queries `__ + * `CodeQL packs for custom tests `__ +* `Examples of CodeQL packs in the CodeQL repository `__ + * `Core library pack `__ + * `Core query pack `__ + * `Tests for the core CodeQL pack `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/about-codeql-workspaces.rst b/docs/codeql/codeql-cli/about-codeql-workspaces.rst index e1e66adf6bd5..3faa45d7d72d 100644 --- a/docs/codeql/codeql-cli/about-codeql-workspaces.rst +++ b/docs/codeql/codeql-cli/about-codeql-workspaces.rst @@ -7,4 +7,10 @@ About CodeQL workspaces This article was moved to "`About CodeQL workspaces `__" on the `GitHub Docs `__ site as of January 2023. .. include:: ../reusables/codeql-cli-articles-migration-note.rst - \ No newline at end of file + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `The codeql-workspace.yml file `__ +* `Source dependencies `__ +* `CodeQL workspaces and query resolution `__ + * `Example `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/about-the-codeql-cli.rst b/docs/codeql/codeql-cli/about-the-codeql-cli.rst index 9d446ccee8eb..e155d5f12e0b 100644 --- a/docs/codeql/codeql-cli/about-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/about-the-codeql-cli.rst @@ -6,4 +6,8 @@ About the CodeQL CLI .. pull-quote:: This article was moved to "`About the CodeQL CLI `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `CodeQL CLI commands `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst index 018aa6b8b4fb..0739abccdeae 100644 --- a/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst @@ -6,4 +6,20 @@ Analyzing databases with the CodeQL CLI .. pull-quote:: This article was moved to "`Analyzing databases with the CodeQL CLI `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `Running codeql database analyze `__ +* `Specifying which queries to run in a CodeQL pack `__ + * `Example query specifiers `__ +* `Examples of running database analyses `__ + * `Running a CodeQL query pack `__ + * `Running a single query `__ + * `Running all queries in a directory `__ + * `Running a subset of queries in a CodeQL pack `__ + * `Running query suites `__ + * `Diagnostic and summary information `__ + * `Integrating a CodeQL pack into a code scanning workflow in GitHub `__ + * `Including query help for custom CodeQL queries in SARIF files `__ +* `Results `__ diff --git a/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst b/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst index d5e83ac93cd9..5354a9eabd10 100644 --- a/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst +++ b/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst @@ -6,4 +6,12 @@ Creating and working with CodeQL packs .. pull-quote:: This article was moved to "`Creating and working with CodeQL packs `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `About CodeQL packs and the CodeQL CLI `__ +* `Creating a CodeQL pack `__ +* `Modifying an existing legacy QL pack to create a CodeQL pack `__ +* `Adding and installing dependencies to a CodeQL pack `__ +* `Customizing a downloaded CodeQL pack `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/creating-codeql-databases.rst b/docs/codeql/codeql-cli/creating-codeql-databases.rst index 9bc77943fbca..be57b0827589 100644 --- a/docs/codeql/codeql-cli/creating-codeql-databases.rst +++ b/docs/codeql/codeql-cli/creating-codeql-databases.rst @@ -6,4 +6,19 @@ Creating CodeQL databases .. pull-quote:: This article was moved to "`Creating CodeQL databases `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `Running codeql database create `__ +* `Progress and results `__ +* `Creating databases for non-compiled languages `__ + * `JavaScript and TypeScript `__ + * `Python `__ + * `Ruby `__ +* `Creating databases for compiled languages `__ + * `Detecting the build system `__ + * `Specifying build commands `__ + * `Using indirect build tracing `__ + * `Example of creating a CodeQL database using indirect build tracing `__ +* `Downloading databases from GitHub.com `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/creating-codeql-query-suites.rst b/docs/codeql/codeql-cli/creating-codeql-query-suites.rst index 08e5c3d75711..fc1980970bb3 100644 --- a/docs/codeql/codeql-cli/creating-codeql-query-suites.rst +++ b/docs/codeql/codeql-cli/creating-codeql-query-suites.rst @@ -6,4 +6,16 @@ Creating CodeQL query suites .. pull-quote:: This article was moved to "`Creating CodeQL query suites `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `Locating queries to add to a query suite `__ +* `Filtering the queries in a query suite `__ + * `Examples of filtering which queries are run `__ +* `Reusing existing query suite definitions `__ + * `Reusability Examples `__ +* `Naming a query suite `__ +* `Saving a query suite `__ +* `Specifying well-known query suites `__ +* `Using query suites with CodeQL `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/exit-codes.rst b/docs/codeql/codeql-cli/exit-codes.rst index 1c01dd45706f..2bb115e6d812 100644 --- a/docs/codeql/codeql-cli/exit-codes.rst +++ b/docs/codeql/codeql-cli/exit-codes.rst @@ -6,4 +6,4 @@ Exit codes .. pull-quote:: This article was moved to "`Exit codes `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst diff --git a/docs/codeql/codeql-cli/extractor-options.rst b/docs/codeql/codeql-cli/extractor-options.rst index a9b67c19a0d7..76728426ffdb 100644 --- a/docs/codeql/codeql-cli/extractor-options.rst +++ b/docs/codeql/codeql-cli/extractor-options.rst @@ -6,4 +6,10 @@ Extractor options .. pull-quote:: This article was moved to "`Extractor options `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `About extractor options `__ +* `Setting extractor options with the CodeQL CLI `__ +* `Setting extractor options from files `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst index 70c260890034..1d2a37957e52 100644 --- a/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst @@ -6,4 +6,20 @@ Getting started with the CodeQL CLI .. pull-quote:: This article was moved to "`Getting started with the CodeQL CLI `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `Setting up the CodeQL CLI `__ + * `1. Download the CodeQL CLI zip package `__ + * `2. Extract the zip archive `__ + * `3. Launch codeql `__ + * `4. Verify your CodeQL CLI setup `__ +* `Checking out the CodeQL source code directly `__ + * `1. Download the CodeQL CLI zip `__ + * `2. Create a new CodeQL directory `__ + * `3. Obtain a local copy of the CodeQL queries `__ + * `4. Extract the zip archive `__ + * `5. Launch codeql `__ + * `6. Verify your CodeQL CLI setup `__ +* `Using two versions of the CodeQL CLI `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst b/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst index ad025d7d480c..9eefe82cf6f1 100644 --- a/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst +++ b/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst @@ -6,4 +6,14 @@ Publishing and using CodeQL packs .. pull-quote:: This article was moved to "`Publishing and using CodeQL packs `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `Configuring the qlpack.yml file before publishing `__ +* `Running codeql pack publish `__ +* `Running codeql pack download / `__ +* `Using a CodeQL pack to analyze a CodeQL database `__ +* `About CodeQL pack compatibility `__ +* `Working with CodeQL packs on GitHub Enterprise Server `__ +* `Authenticating to GitHub Container registries `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/query-reference-files.rst b/docs/codeql/codeql-cli/query-reference-files.rst index e468b1448a76..1958f0c34ea1 100644 --- a/docs/codeql/codeql-cli/query-reference-files.rst +++ b/docs/codeql/codeql-cli/query-reference-files.rst @@ -6,4 +6,9 @@ Query reference files .. pull-quote:: This article was moved to "`Query reference files `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `Defining a query reference file `__ + * `Example `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/sarif-output.rst b/docs/codeql/codeql-cli/sarif-output.rst index 64b659a1afaa..7a134f32ace9 100644 --- a/docs/codeql/codeql-cli/sarif-output.rst +++ b/docs/codeql/codeql-cli/sarif-output.rst @@ -6,4 +6,26 @@ SARIF output .. pull-quote:: This article was moved to "`CodeQL CLI SARIF output `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `SARIF specification and schema `__ +* `Change notes `__ + * `Changes between versions `__ + * `Future changes to the output `__ +* `Generated SARIF objects `__ + * `sarifLog object `__ + * `run object `__ + * `tool object `__ + * `toolComponent object `__ + * `reportingDescriptor object for rule `__ + * `artifact object `__ + * `artifactLocation object `__ + * `result object `__ + * `location object `__ + * `physicalLocation object `__ + * `region object `__ + * `codeFlow object `__ + * `threadFlow object `__ + * `threadFlowLocation object `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst b/docs/codeql/codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst index 2c2a920fce20..5b88acb86a82 100644 --- a/docs/codeql/codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst +++ b/docs/codeql/codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst @@ -6,4 +6,9 @@ Specifying command options in a CodeQL configuration file .. pull-quote:: This article was moved to "`Specifying command options in a CodeQL configuration file `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + + .. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `Using a CodeQL configuration file `__ + * `Examples `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/testing-custom-queries.rst b/docs/codeql/codeql-cli/testing-custom-queries.rst index 3177a9b6ec29..65560597d784 100644 --- a/docs/codeql/codeql-cli/testing-custom-queries.rst +++ b/docs/codeql/codeql-cli/testing-custom-queries.rst @@ -6,4 +6,14 @@ Testing custom queries .. pull-quote:: This article was moved to "`Testing custom queries `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `Setting up a test CodeQL pack for custom queries `__ +* `Setting up the test files for a query `__ +* `Running codeql test run `__ +* `Example `__ + * `Prepare a query and test files `__ + * `Execute the test `__ + * `View the query test output `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/testing-query-help-files.rst b/docs/codeql/codeql-cli/testing-query-help-files.rst index 0a5277bfc282..01f5521f8066 100644 --- a/docs/codeql/codeql-cli/testing-query-help-files.rst +++ b/docs/codeql/codeql-cli/testing-query-help-files.rst @@ -6,4 +6,10 @@ Testing query help files .. pull-quote:: This article was moved to "`Testing query help files `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `Prerequisites `__ +* `Running codeql generate query-help `__ +* `Results `__ \ No newline at end of file diff --git a/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst index eb096c8033d4..393a94f7ec92 100644 --- a/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst @@ -6,4 +6,11 @@ Using custom queries with the CodeQL CLI .. pull-quote:: This article was moved to "`Using custom queries with the CodeQL CLI `__" on the `GitHub Docs `__ site as of January 2023. - .. include:: ../reusables/codeql-cli-articles-migration-note.rst \ No newline at end of file + .. include:: ../reusables/codeql-cli-articles-migration-note.rst + +.. include:: ../reusables/codeql-cli-migration-toc-note.rst + +* `Writing a valid query `__ +* `Including query metadata `__ +* `Packaging custom QL queries `__ +* `Contributing to the CodeQL repository `__ \ No newline at end of file diff --git a/docs/codeql/reusables/codeql-cli-migration-toc-note.rst b/docs/codeql/reusables/codeql-cli-migration-toc-note.rst new file mode 100644 index 000000000000..9e13f93567d9 --- /dev/null +++ b/docs/codeql/reusables/codeql-cli-migration-toc-note.rst @@ -0,0 +1 @@ +If you want to go to a specific subsection in the new location, see the TOC links below. \ No newline at end of file