Docs: Describe custom log directory setting in VS Code extension#5946
Docs: Describe custom log directory setting in VS Code extension#5946shati-patel merged 2 commits intogithub:mainfrom
Conversation
|
👋 docs first responder here! I've added this to our review board for someone to have a look at 🚀 |
|
@shati-patel 👋🏻 😃 - I've volunteered to review this and I was wondering if you could provide a preview of the updates, or if I need to get your branch and build the docs myself. Can you remind me? Thanks very much. |
Thanks! If you have Sphinx installed locally, you can indeed pull down the branch and generate a preview. But there's also a preview that's generated as part of the PR checks: If you click "Details" in the Docs - Generate Sphinx check below, there's an HTML artifact that you can download: |
mchammer01
left a comment
There was a problem hiding this comment.
@shati-patel - this LGTM ✨
Just a few minor questions/comments.
docs/codeql/codeql-for-visual-studio-code/troubleshooting-codeql-for-visual-studio-code.rst
Show resolved
Hide resolved
mchammer01
left a comment
There was a problem hiding this comment.
@shati-patel - thanks for the updates, it looks great to me ⚡
mchammer01
left a comment
There was a problem hiding this comment.
@shati-patel - thanks for updating the wording and for improving the bit about log saving and deleting ⚡
|
Thanks again for the review! ✨ This PR is now ready. I'll merge once a new version of the CodeQL extension is released 🙂 |
|
v1.5.0 of the extension has been released, so this is good to merge ⚡ |

In the next release of CodeQL for VS Code, users will have the option to specify a custom log directory.
This looked like a sensible place to update the docs 🙂
PS: We haven't yet released the feature in the extension, so don't merge this docs PR just yet!Release v1.5.0 on its way...Associated issue: github/vscode-codeql#820
Implemented in: github/vscode-codeql#863