|
4 | 4 | "isPrimary": true, |
5 | 5 | "steps": [ |
6 | 6 | { |
7 | | - "description": "The CodeQL extension uses the CodeQL CLI to compile and run queries. It automatically manages access to the executable of the CLI for you.\n\nClick 'Next' when you see a popup notification telling you that the CLI has been installed or updated.", |
8 | | - "commands": [ |
9 | | - "codeQL.checkForUpdatesToCLI" |
10 | | - ], |
11 | | - "title": "Set up extension" |
| 7 | + "description": "First let's talk about the CodeQL CLI.\n\nThe CodeQL extension uses the CodeQL CLI to compile and run queries. It automatically manages access to the executable of the CLI for you.\n\nWe've already set it up to use in this tutorial. To learn more about the CodeQL CLI, see [the docs](https://codeql.github.com/).", |
| 8 | + "title": "The CodeQL CLI" |
12 | 9 | }, |
13 | 10 | { |
14 | 11 | "directory": ".tours/codeql-tutorial-database", |
15 | | - "description": "To run a CodeQL query, we need to select a CodeQL database.\n\nWe have prepared a sample database for you to use in this tutorial. We have selected this as your current database.", |
| 12 | + "description": "To run a CodeQL query, we first need to select [a CodeQL database](https://codeql.github.com/docs/codeql-overview/about-codeql/#about-codeql-databases).\n\nWe've just added a sample one and set it as your current database.\n\nClick 'Next' to see the database.", |
16 | 13 | "commands": [ |
17 | 14 | "codeQL.setDefaultTourDatabase" |
18 | 15 | ], |
19 | 16 | "title": "Your first database" |
20 | 17 | }, |
21 | 18 | { |
22 | | - "title": "Extension", |
23 | | - "description": "It's time to check out the extension!\n\nIn the CodeQL view, you can see that the 'CodeQL Tutorial Database' is present in the 'Databases' panel and is selected with a check mark.", |
| 19 | + "title": "The CodeQL extension", |
| 20 | + "description": "We've now moved into the CodeQL extension!\n\nOn the left hand side, you can see the 'DATABASES' panel where the 'CodeQL Tutorial Database' is present and is selected with a check mark.", |
24 | 21 | "view": "codeQLDatabases" |
25 | 22 | }, |
26 | 23 | { |
27 | 24 | "file": "tutorial-queries/tutorial.ql", |
28 | | - "description": "Now let's look at a query.\n\nThis is a CodeQL query file. It has a `.ql` file extension.", |
| 25 | + "description": "Now let's look at [a CodeQL query](https://codeql.github.com/docs/writing-codeql-queries/codeql-queries/).\n\nThis is a query file. It has a `.ql` file extension.", |
29 | 26 | "line": 1, |
30 | 27 | "title": "Your first query" |
31 | 28 | }, |
|
37 | 34 | }, |
38 | 35 | { |
39 | 36 | "file": "tutorial-queries/tutorial.ql", |
40 | | - "description": "This is the query clause. It determines the output of the query. Click 'Next' to run the query!", |
| 37 | + "description": "This is the query clause.\n\nIt determines the output of the query. Click 'Next' to run the query!", |
41 | 38 | "selection": { |
42 | 39 | "start": { |
43 | 40 | "line": 7, |
|
52 | 49 | }, |
53 | 50 | { |
54 | 51 | "file": "tutorial-queries/tutorial.ql", |
55 | | - "description": "It is time to run your first query!\n\n We started the process in the background, the results will appear in a new 'CodeQL Query Results' tab shortly.", |
| 52 | + "description": "It is time to run your first query!\n\nWe started the process in the background, the results will appear in a new 'CodeQL Query Results' tab shortly.", |
56 | 53 | "selection": { |
57 | 54 | "start": { |
58 | 55 | "line": 7, |
|
81 | 78 | "character": 1 |
82 | 79 | } |
83 | 80 | }, |
84 | | - "title": "Query history", |
| 81 | + "title": "Query History", |
85 | 82 | "view": "codeQLQueryHistory" |
86 | 83 | }, |
87 | 84 | { |
|
117 | 114 | }, |
118 | 115 | { |
119 | 116 | "title": "CodeQL pack", |
120 | | - "description": "After adding a database we create a new CodeQL pack for you.\n\nThis loads all dependencies needed for the language of the database, and creates an example query that you can run and modify. Open `example.ql` inside the 'codeql-custom-queries-*' folder to get started.", |
| 117 | + "description": "After adding a database we create a new CodeQL pack for you.\n\nThis loads all dependencies needed for the language of the database, and creates an example query that you can run and modify.\n\nOpen `example.ql` inside the 'codeql-custom-queries-*' folder to get started.", |
121 | 118 | "view": "explorer" |
122 | 119 | } |
123 | 120 | ] |
|
0 commit comments