Skip to content

Commit ebdb3e2

Browse files
authored
Merge pull request github#4768 from github/query-and-library-links
Update query and library links for new locations
2 parents 2484941 + 45a4d5b commit ebdb3e2

File tree

53 files changed

+2657
-1927
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+2657
-1927
lines changed

docs/codeql/_templates/layout.html

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -38,27 +38,19 @@
3838
{%- block content %}
3939
<header class="Header">
4040
<div class="Header-item--full">
41-
<a href="{{ pathto(master_doc) }}" class="Header-link f2 d-flex flex-items-center">
41+
<a href="https://codeql.github.com/docs" class="Header-link f2 d-flex flex-items-center">
4242
<!-- <%= octicon "mark-github", class: "mr-2", height: 32 %> -->
4343
<svg height="32" class="octicon octicon-mark-github mr-2" viewBox="0 0 16 16" version="1.1" width="32"
4444
aria-hidden="true">
4545
<path fill-rule="evenodd"
4646
d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z">
4747
</path>
4848
</svg>
49-
<span class="hide-sm">{{ project }}</span>
49+
<span class="hide-sm">CodeQL documentation</span>
5050
</a>
5151
</div>
5252
<div class="Header-item hide-sm hide-md">
53-
<form class="search" action="{{ pathto('search') }}" method="get">
54-
<input class="form-control input-dark" type="text" name="q" placeholder="Search" />
55-
<input class="btn" type="submit" value="Search" />
56-
<input type="hidden" name="check_keywords" value="yes" />
57-
<input type="hidden" name="area" value="default" />
58-
</form>
59-
<script type="text/javascript">$('#searchbox').show(0);</script>
60-
61-
<div class="clearer"></div>
53+
<script src="https://addsearch.com/js/?key=93b4d287e2fc079a4089412b669785d5&categories=!0xhelp.semmle.com,0xcodeql.github.com,1xdocs,1xcodeql-standard-libraries,1xcodeql-query-help"></script>
6254
</div>
6355
<div class="Header-item">
6456

@@ -69,20 +61,30 @@
6961
</summary>
7062

7163
<ul class="dropdown-menu dropdown-menu-se dropdown-menu-dark">
64+
<li><a class="dropdown-item" href="https://codeql.github.com/docs/codeql-overview">CodeQL overview</a></li>
65+
<li class="dropdown-divider" role="separator"></li>
7266
<div class="dropdown-header">
73-
Help docs
67+
CodeQL tools
7468
</div>
75-
<li><a class="dropdown-item" href="https://help.semmle.com/QL/learn-ql/">Learn CodeQL</a></li>
76-
<li><a class="dropdown-item" href="https://help.semmle.com/codeql/codeql-tools.html">CodeQL tools</a>
69+
<li><a class="dropdown-item" href="https://codeql.github.com/docs/codeql-for-visual-studio-code">CodeQL for VS Code</a>
70+
<li><a class="dropdown-item" href="https://codeql.github.com/docs/codeql-cli">CodeQL CLI</a>
7771
</li>
7872
<li class="dropdown-divider" role="separator"></li>
73+
<div class="dropdown-header">
74+
CodeQL guides
75+
</div>
76+
<li><a class="dropdown-item" href="https://codeql.github.com/docs/writing-codeql-queries">Writing CodeQL queries</a></li>
77+
<li><a class="dropdown-item" href="https://codeql.github.com/docs/codeql-language-guides">CodeQL language guides</a>
78+
<li class="dropdown-divider" role="separator"></li>
7979
<div class="dropdown-header">
8080
Reference docs
8181
</div>
82-
<li><a class="dropdown-item" href="https://help.semmle.com/QL/ql-handbook/">QL language reference</a>
83-
<li><a class="dropdown-item" href="https://help.semmle.com/QL/ql-libraries.html">CodeQL libraries</a>
84-
<li><a class="dropdown-item" href="https://help.semmle.com/QL/ql-built-in-queries.html">CodeQL
85-
queries</a>
82+
<li><a class="dropdown-item" href="https://codeql.github.com/docs/ql-language-reference/">QL language
83+
reference</a>
84+
<li><a class="dropdown-item" href="https://codeql.github.com/codeql-standard-libraries">CodeQL
85+
standard-libraries</a>
86+
<li><a class="dropdown-item" href="https://codeql.github.com/codeql-query-help">CodeQL
87+
query help</a>
8688
<li class="dropdown-divider" role="separator"></li>
8789
<div class="dropdown-header">
8890
Source files

docs/codeql/codeql-cli/about-the-codeql-cli.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ command line. To run a command, use::
2626
codeql [command] [subcommand]
2727

2828
To view the reference documentation for a command, add the ``--help`` flag, or visit the
29-
"`CodeQL CLI manual <../../codeql-cli-manual>`__."
29+
"`CodeQL CLI manual <../manual>`__."

docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ You must specify:
4949
<sarif-file>`, and graph formats. For more information about CSV and SARIF,
5050
see `Results <#results>`__. To find out which other results formats are
5151
supported, see the `database analyze reference
52-
<../codeql-cli-manual/database-analyze.html>`__.
52+
<../manual/database-analyze>`__.
5353

5454
- ``--output``: the output path of the results file generated during analysis.
5555

@@ -70,7 +70,7 @@ You can also specify:
7070
<upgrading-codeql-databases>`."
7171

7272
For full details of all the options you can use when analyzing databases, see
73-
the `database analyze reference documentation <../codeql-cli-manual/database-analyze.html>`__.
73+
the `database analyze reference documentation <../manual/database-analyze>`__.
7474

7575
.. _database-analyze-examples:
7676

docs/codeql/codeql-cli/codeql-cli-reference.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ CodeQL CLI manual
2828
-----------------
2929

3030
To view detailed information about each CodeQL CLI command,
31-
including its usage and options, add the ``--help`` flag or visit the "`CodeQL CLI manual <../codeql-cli-manual>`__."
31+
including its usage and options, add the ``--help`` flag or visit the "`CodeQL CLI manual <../manual>`__."

docs/codeql/codeql-cli/creating-codeql-databases.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ the language you want to analyze:
5050
detect the build system automatically, using a built-in autobuilder.
5151

5252
For full details of all the options you can use when creating databases,
53-
see the `database create reference documentation <../codeql-cli-manual/database-create.html>`__.
53+
see the `database create reference documentation <../manual/database-create>`__.
5454

5555
Progress and results
5656
--------------------

docs/codeql/codeql-cli/creating-codeql-query-suites.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ instruction::
234234
- description: <name-of-query-suite>
235235

236236
This value is displayed when you run `codeql resolve queries
237-
<../codeql-cli-manual/resolve-queries.html>`__, if the suite is added to a "well-known"
237+
<../manual/resolve-queries>`__, if the suite is added to a "well-known"
238238
directory. For more information, see "`Specifying well-known query suites
239239
<#specifying-well-known-query-suites>`__."
240240

docs/codeql/codeql-cli/exit-codes.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Success, normal termination.
1616

1717
The command successfully determined that the answer to your question is "no".
1818

19-
This exit code is only used by a few commands, such as `codeql test run <../codeql-cli-manual/test-run.html>`__, `codeql database check <../codeql-cli-manual/dataset-check.html>`__, `codeql query format <../codeql-cli-manual/query-format.html>`__,and `codeql resolve extractor <../codeql-cli-manual/resolve-extractor.html>`__.
19+
This exit code is only used by a few commands, such as `codeql test run <../manual/test-run>`__, `codeql database check <../manual/dataset-check>`__, `codeql query format <../manual/query-format>`__,and `codeql resolve extractor <../manual/resolve-extractor>`__.
2020
For more details, see the documentation for those commands.
2121

2222
2
@@ -37,7 +37,7 @@ In this case, the launcher can't start the Java code for the CodeQL CLI at all.
3737
32
3838
---
3939

40-
The extractor didn't find any code to analyze when running `codeql database create <../codeql-cli-manual/database-create.html>`__ or `codeql database finalize <../codeql-cli-manual/database-finalize.html>`__.
40+
The extractor didn't find any code to analyze when running `codeql database create <../manual/database-create>`__ or `codeql database finalize <../manual/database-finalize>`__.
4141

4242
33
4343
---

docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ executable in a couple of ways:
184184
can run the executable as just ``codeql``.
185185

186186
At this point, you can execute CodeQL commands. For a full list of the CodeQL
187-
CLI commands, see the "`CodeQL CLI manual <../../codeql-cli-manual>`__."
187+
CLI commands, see the "`CodeQL CLI manual <../manual>`__."
188188

189189
.. pull-quote:: Note
190190

docs/codeql/codeql-cli/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ CodeQL CLI
1010

1111
- :ref:`CodeQL CLI reference <codeql-cli-reference>`: Learn more about the files you can use when running CodeQL processes and the results format and exit codes that CodeQL generates.
1212

13-
- `CodeQL CLI manual <../codeql-cli-manual>`__: Detailed information about all the commands available with the CodeQL CLI.
13+
- `CodeQL CLI manual <manual>`__: Detailed information about all the commands available with the CodeQL CLI.
1414

1515
.. toctree::
1616
:titlesonly:

docs/codeql/codeql-cli/sarif-output.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ considered "optional". This document details the output produced when using the
1111
format type ``sarifv2.1.0``, which corresponds to the SARIF v2.1.0.csd1
1212
specification.
1313
For more information on selecting a file format for your analysis results, see
14-
the `database analyze reference <../codeql-cli-manual/database-analyze.html>`__.
14+
the `database analyze reference <../manual/database-analyze>`__.
1515

1616
SARIF specification and schema
1717
------------------------------

0 commit comments

Comments
 (0)