Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update links in VS Marketplace README #3611

Merged
merged 2 commits into from
May 15, 2024
Merged

Conversation

subatoi
Copy link
Contributor

@subatoi subatoi commented May 15, 2024

Now that the full documentation has been migrated to docs.github.com, I've updated links in the VS Marketplace README. I'm not sure any items in the checklist are applicable so I've left them unchecked for now.

Checklist

  • CHANGELOG.md has been updated to incorporate all user visible changes made by this pull request.
  • Issues have been created for any UI or other user-facing changes made by this pull request.
  • [Maintainers only] If this pull request makes user-facing changes that require documentation changes, open a corresponding docs pull request in the github/codeql repo and add the ready-for-doc-review label there.

@subatoi subatoi requested a review from a team as a code owner May 15, 2024 08:26
Copy link
Contributor

@shati-patel shati-patel left a comment

Choose a reason for hiding this comment

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

Thanks for the updates 🎉 Just one comment about removing the hard-coded en links!

@@ -9,10 +9,12 @@ This project is an extension for Visual Studio Code that adds rich language supp

To see what has changed in the last few versions of the extension, see the [Changelog](https://github.com/github/vscode-codeql/blob/main/extensions/ql-vscode/CHANGELOG.md).

You can also read full documentation for the extension on the [GitHub documentation website](https://docs.github.com/en/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
You can also read full documentation for the extension on the [GitHub documentation website](https://docs.github.com/en/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension).
You can also read full documentation for the extension on the [GitHub documentation website](https://docs.github.com/code-security/codeql-for-vs-code/using-the-advanced-functionality-of-the-codeql-for-vs-code-extension).

Shall we omit the language (here and in the other links below)? In case this ends up getting translated to other languages too 😁

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good call, thanks! ✅

@@ -106,7 +108,7 @@ If you wish to navigate the query results from your keyboard, you can bind short

## What next?

For more information about the CodeQL extension, [see the documentation](https://codeql.github.com/docs/codeql-for-visual-studio-code/). Otherwise, you could:
We recommend reading the [full documentation for the extension](https://docs.github.com/en/code-security/codeql-for-vs-code/) on the GitHub documentation website. You may also find the following resources useful:

- [Create a database for a different codebase](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/).
- [Try out variant analysis](https://help.semmle.com/QL/learn-ql/ql-training.html).
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like we need to update some more (very old!) links 🤦🏽

Not related to your changes, so I'll do this in a follow-up PR ✔️

@shati-patel shati-patel enabled auto-merge (squash) May 15, 2024 08:48
@shati-patel shati-patel merged commit 1dc48b3 into github:main May 15, 2024
15 checks passed
@subatoi subatoi deleted the patch-1 branch May 15, 2024 09:07
@subatoi
Copy link
Contributor Author

subatoi commented May 24, 2024

@shati-patel 👋 do you know when these changes will propagate to https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-codeql just so I can tick off the last remaining item on my todo list related to that project? 😁

@shati-patel
Copy link
Contributor

@shati-patel 👋 do you know when these changes will propagate to https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-codeql just so I can tick off the last remaining item on my todo list related to that project? 😁

They'll go live when we do the next extension release! That should be in the coming week or two 🚀 (No more work needed from your end ⚡)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants