Docs: add path query example to data flow docs#20622
Conversation
owen-mc
added
the
ready-for-doc-review
felicitymay
left a comment
felicitymay
left a comment
There was a problem hiding this comment.
Many thanks for your help generating the output files @owen-mc 💖
The formatting here looks generally good. I've added a few comments about improving findability and on sentence case, but very little to say on the Docs side.
| @@ -411,6 +411,48 @@ Exercise 4 | |||
| GetenvToGethostbynameFlow::flow(source, sink) | |||
| select getenv, fc | |||
|
|
|||
There was a problem hiding this comment.
I'd recommend adding a link to this example to line 318, after the description of Exercise 4, to make it easier for users to find this example.
I'd suggest a similar change to all articles that have exercise numbering like this - I think that's everything down to and including JavaScript/TypeScript.
| GetenvToGethostbynameFlow::flow(source, sink) | ||
| select getenv, fc | ||
|
|
||
| Path Query Example |
There was a problem hiding this comment.
We use sentence case:
| Path Query Example | |
| Path query example |
Please update in all files
| Path Query Example | ||
| ~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Here is the first example above, converted into a path query: |
There was a problem hiding this comment.
It would be good to be more explicit here, maybe:
| Here is the first example above, converted into a path query: | |
| Here is the network input example above, converted into a path query: |
Alternatively, you could give the two queries above a heading.
| Path Query Example | ||
| ~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Here is the first example above, converted into a path query: |
There was a problem hiding this comment.
The same comment on the Python description applies here and to the Ruby, Rust, and Swift examples.
| --------------- | ||
|
|
||
| - `Exploring data flow with path queries <https://docs.github.com/en/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/exploring-data-flow-with-path-queries>`__ in the GitHub documentation. | ||
| - `Creating path queries <https://codeql.github.com/docs/writing-codeql-queries/creating-path-queries/>`__ in the GitHub documentation. |
There was a problem hiding this comment.
We've changed docs sites from GitHub to CodeQL, so we can simplify this:
| - `Creating path queries <https://codeql.github.com/docs/writing-codeql-queries/creating-path-queries/>`__ in the GitHub documentation. | |
| - `Creating path queries <https://codeql.github.com/docs/writing-codeql-queries/creating-path-queries/>`__. |
|
Thanks @felicitymay . I think I've addressed all of those comments now. |
felicitymay
left a comment
felicitymay
left a comment
There was a problem hiding this comment.
Many thanks for the updates @owen-mc ✨
This looks ready to merge.
This is inspired by, and supersedes, #20620.
Also fix some mistakes in the go data flow docs that I noticed while doing this.