Skip to content

Docs: Describe custom log directory setting in VS Code extension#5946

Merged
shati-patel merged 2 commits intogithub:mainfrom
shati-patel:vscode-custom-logs
Jun 14, 2021
Merged

Docs: Describe custom log directory setting in VS Code extension#5946
shati-patel merged 2 commits intogithub:mainfrom
shati-patel:vscode-custom-logs

Conversation

@shati-patel
Copy link
Copy Markdown
Contributor

@shati-patel shati-patel commented May 21, 2021

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

@shati-patel shati-patel added the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label May 21, 2021
@lucascosti
Copy link
Copy Markdown

👋 docs first responder here! I've added this to our review board for someone to have a look at 🚀

@mchammer01 mchammer01 self-assigned this May 25, 2021
@mchammer01
Copy link
Copy Markdown
Contributor

@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.

@shati-patel
Copy link
Copy Markdown
Contributor Author

@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:

image

mchammer01
mchammer01 previously approved these changes May 25, 2021
Copy link
Copy Markdown
Contributor

@mchammer01 mchammer01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shati-patel - this LGTM ✨
Just a few minor questions/comments.

Copy link
Copy Markdown
Contributor

@mchammer01 mchammer01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shati-patel - thanks for the updates, it looks great to me ⚡

Copy link
Copy Markdown
Contributor

@mchammer01 mchammer01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shati-patel - thanks for updating the wording and for improving the bit about log saving and deleting ⚡

@shati-patel shati-patel removed the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label May 25, 2021
@shati-patel
Copy link
Copy Markdown
Contributor Author

Thanks again for the review! ✨

This PR is now ready. I'll merge once a new version of the CodeQL extension is released 🙂

@mchammer01 mchammer01 removed their assignment May 28, 2021
@shati-patel
Copy link
Copy Markdown
Contributor Author

v1.5.0 of the extension has been released, so this is good to merge ⚡

@shati-patel shati-patel merged commit cce8eac into github:main Jun 14, 2021
@shati-patel shati-patel deleted the vscode-custom-logs branch June 14, 2021 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants