docs: apply Snyk writing-style skill to Developer tools pages#1369
Open
TashaTBaker wants to merge 1 commit into
Open
docs: apply Snyk writing-style skill to Developer tools pages#1369TashaTBaker wants to merge 1 commit into
TashaTBaker wants to merge 1 commit into
Conversation
Apply the Snyk documentation writing-style rules across the developer-tools
section (297 files updated).
Consistent changes:
- Passive to active voice; present tense over future "will"
- Capability phrasing ("allows/enables you to" -> "lets you"); "is able to" -> "can"
- once -> after; in order to -> to; via -> through/using; make sure -> ensure;
go to -> navigate to; remove filler (just, simply, easily, currently)
- Bold UI labels without element-type nouns; check box "select/clear"
- Casing: Node.js, GitHub, Bitbucket, Azure DevOps, IaC, AI-BOM; Snyk Web UI;
Projects/Organizations/Groups; AI buzzwords removed
- Fix copy-paste/product-name slips and obvious prose typos
Frontmatter, GitBook/OpenAPI components, code, links, and technical literals unchanged.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
mikeromard
reviewed
Jun 18, 2026
| ### External ID for a Single Snyk Organization | ||
|
|
||
| If you are creating this integration for a single Snyk Organization, you will use your Snyk **Organization ID** as the **External ID.** You can find your Organization ID under Snyk **Organization Settings**. | ||
| If you are creating this integration for a single Snyk Organization, use your Snyk **Organization ID** as the **External ID.** You can find your Organization ID under Snyk **Organization Settings**. |
Contributor
There was a problem hiding this comment.
Suggested change
| If you are creating this integration for a single Snyk Organization, use your Snyk **Organization ID** as the **External ID.** You can find your Organization ID under Snyk **Organization Settings**. | |
| If you are creating this integration for a single Snyk Organization, use your Snyk **Organization ID** as the **External ID**. You can find your Organization ID under Snyk **Organization Settings**. |
| * Open the **Integrations** menu. | ||
| * Select the **Add integration** option. | ||
| * Select **Add integration**. | ||
| * Select the **Issue Forwardin**g tag and search for CrowdStrike Issue Forwarding. |
Contributor
There was a problem hiding this comment.
Suggested change
| * Select the **Issue Forwardin**g tag and search for CrowdStrike Issue Forwarding. | |
| * Select the **Issue Forwarding** tag and search for CrowdStrike Issue Forwarding. |
|
|
||
| * Snyk supports Jira from version 5 to version 10. | ||
| * The following [Jira permissions](https://confluence.atlassian.com/adminjiraserver073/managing-project-permissions-861253293.html) are required: **Browse Projects** and **Create Issues.** | ||
| * You need the following [Jira permissions](https://confluence.atlassian.com/adminjiraserver073/managing-project-permissions-861253293.html): **Browse Projects** and **Create Issues.** |
Contributor
There was a problem hiding this comment.
Suggested change
| * You need the following [Jira permissions](https://confluence.atlassian.com/adminjiraserver073/managing-project-permissions-861253293.html): **Browse Projects** and **Create Issues.** | |
| * You need the following [Jira permissions](https://confluence.atlassian.com/adminjiraserver073/managing-project-permissions-861253293.html): **Browse Projects** and **Create Issues**. |
| 2. Click the **Connect security containers** button. | ||
| 3. Click on the Snyk application and then select **Connect security containers**. | ||
| 2. Click **Connect security containers**. | ||
| 3. Click the Snyk application and then select **Connect security containers**. |
Contributor
There was a problem hiding this comment.
Suggested change
| 3. Click the Snyk application and then select **Connect security containers**. | |
| 3. Click the Snyk application and then select **Connect security containers**. |
| ### How to set up a Bitbucket DC/Server Integration | ||
|
|
||
| 1. To give Snyk access to your Bitbucket DC/Server account, set up a dedicated service account in Bitbucket DC/Server with admin permissions.\ | ||
| Visit [Bitbucket Server documentation ](https://confluence.atlassian.com/bitbucketserver/users-and-groups-776640439.html#Usersandgroups-Creatingauser)to learn more about creating users.\ |
Contributor
There was a problem hiding this comment.
Suggested change
| Visit [Bitbucket Server documentation ](https://confluence.atlassian.com/bitbucketserver/users-and-groups-776640439.html#Usersandgroups-Creatingauser)to learn more about creating users.\ | |
| Visit [Bitbucket Server documentation](https://confluence.atlassian.com/bitbucketserver/users-and-groups-776640439.html#Usersandgroups-Creatingauser) to learn more about creating users.\ |
| Follow these steps to authenticate: | ||
|
|
||
| 1. After the extension is installed, click the **Snyk Icon** in the navigation bar, then click **Connect & Trust Workspace**: | ||
| 1. After you install the extension, click the **Snyk Icon** in the navigation bar, then click **Connect & Trust Workspace**: |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. After you install the extension, click the **Snyk Icon** in the navigation bar, then click **Connect & Trust Workspace**: | |
| 1. After you install the extension, click the **Snyk Icon** in the navigation bar, then click **Connect & Trust Workspace**. |
| Install the plugin at any time free of charge from the [Visual Studio Code marketplace](https://marketplace.visualstudio.com/items?itemName=snyk-security.snyk-vulnerability-scanner) and use it with any Snyk account, including a Free account. For more information, see the [VS Code extension installation guide](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-an-extension). | ||
|
|
||
| When the extension is installed, it automatically downloads the [Snyk CLI,](https://docs.snyk.io/snyk-cli) which includes the [Language Server](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/snyk-language-server). | ||
| When you install the extension, it automatically downloads the [Snyk CLI,](https://docs.snyk.io/snyk-cli) which includes the [Language Server](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/snyk-language-server). |
Contributor
There was a problem hiding this comment.
Suggested change
| When you install the extension, it automatically downloads the [Snyk CLI,](https://docs.snyk.io/snyk-cli) which includes the [Language Server](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/snyk-language-server). | |
| When you install the extension, it automatically downloads the [Snyk CLI](https://docs.snyk.io/snyk-cli), which includes the [Language Server](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/snyk-language-server). |
| Follow these steps to authenticate: | ||
|
|
||
| 1. After the extension is installed, navigate to **Extensions** > **Snyk** > **Settings**: | ||
| 1. After you install the extension, navigate to **Extensions** > **Snyk** > **Settings**: |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. After you install the extension, navigate to **Extensions** > **Snyk** > **Settings**: | |
| 1. After you install the extension, navigate to **Extensions** > **Snyk** > **Settings**. |
| You can also open the Snyk tool window using **View** > **Other Windows** > **Snyk**. | ||
|
|
||
| When the extension is installed, it automatically downloads the [Snyk CLI,](https://docs.snyk.io/snyk-cli) which includes the [Language Server](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/snyk-language-server). | ||
| When you install the extension, it automatically downloads the [Snyk CLI,](https://docs.snyk.io/snyk-cli) which includes the [Language Server](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/snyk-language-server). |
Contributor
There was a problem hiding this comment.
Suggested change
| When you install the extension, it automatically downloads the [Snyk CLI,](https://docs.snyk.io/snyk-cli) which includes the [Language Server](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/snyk-language-server). | |
| When you install the extension, it automatically downloads the [Snyk CLI](https://docs.snyk.io/snyk-cli), which includes the [Language Server](https://docs.snyk.io/scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/snyk-language-server). |
| @@ -1,4 +1,4 @@ | |||
| # IDE Plugin Compatibility Matrix | |||
| # IDE plugin compatibility matrix | |||
Contributor
There was a problem hiding this comment.
This should be fixed in the automation instead of here, otherwise it will be overwritten.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Applies the Snyk documentation writing-style rules across the Developer tools section (297 files).
Part of the per-section writing-style review. Targets the shared base branch
writing-style-review.Consistent changes
Preserved
Frontmatter, GitBook/OpenAPI components, code/CLI, links/URLs, image paths, and technical literals are unchanged. Auto-generated API reference pages and shared v1-deprecation boilerplate left intact. SUMMARY.md (navigation) not touched.
Generated with Claude Code