Learn CodeQL docs: add short note about new terminology - #2275
Conversation
shati-patel
left a comment
shati-patel
left a comment
There was a problem hiding this comment.
Thanks, this looks pretty clear to me!
I've made two minor suggestions, but feel free to ignore.
Co-Authored-By: shati-patel <42641846+shati-patel@users.noreply.github.com>
Co-Authored-By: shati-patel <42641846+shati-patel@users.noreply.github.com>
felicitymay
left a comment
felicitymay
left a comment
There was a problem hiding this comment.
This looks good. Just one question about a link.
Also, I suggest that we update the home page question "What is CodeQL?" to link to this topic for more information.
| CodeQL databases | ||
| ---------------- | ||
|
|
||
| QL snapshots have been renamed CodeQL databases. :doc:`CodeQL databases <database>` contain relational data created and analyzed using CodeQL. They are the equivalent of QL snapshots, but have been optimized for use with the CodeQL tools. |
There was a problem hiding this comment.
Will this link work outside the CodeQL project?
There was a problem hiding this comment.
That topic is in this project--formerly called snapshot.rst.
(doc/sphinx would also fail if a :doc: link was broken.)
There was a problem hiding this comment.
Ah - sorry, assumed that it was for the glossary in the CodeQL documentation!
|
Thanks for the review @felicitymay.
I'm not sure which question you mean? |
|
The question towards the bottom of the page: http://docteam.internal.semmle.com/felicity/help.semmle.com-SD-4051/help/home.html. It's probably worth modifying the existing text to link to your new topic for more information (at some point). |
|
@shati-patel - do you have any more feedback or is this okay to merge? |
4 participants
Note explaining the use of CodeQL, QL and CodeQL databases in the Learn CodeQL Sphinx project.