docs: apply Snyk writing-style skill to Platform administration pages#1368
Open
TashaTBaker wants to merge 1 commit into
Open
docs: apply Snyk writing-style skill to Platform administration pages#1368TashaTBaker wants to merge 1 commit into
TashaTBaker wants to merge 1 commit into
Conversation
Apply the Snyk documentation writing-style rules across the
platform-administration section (114 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"
- Weaken-modal trimming (may -> can/might where appropriate)
- once -> after; in order to -> to; go to -> navigate to; remove filler (simply, easily)
- Bold UI labels without element-type nouns; Groups/Organizations/Projects casing
- Remove "(s)" plurals; fix obvious typos and provider/casing slips
Frontmatter, GitBook components, HTML tables, 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
| Group viewers cannot create service accounts, regardless of their Org role. | ||
| {% endhint %} | ||
|
|
||
| To create a Group service account**,** you must be a Group admin. To create an Organization service account, you must be either a Group member and Org Admin, or a Group admin. |
Contributor
There was a problem hiding this comment.
Suggested change
| To create a Group service account**,** you must be a Group admin. To create an Organization service account, you must be either a Group member and Org Admin, or a Group admin. | |
| To create a Group service account, you must be a Group admin. To create an Organization service account, you must be either a Group member and Org Admin, or a Group admin. |
|
|
||
| 1. On the main page of Okta select **Directory** > **Groups**. | ||
| 2. Select a **Group**, navigate to the **Applications** tab, click **Assign** **application** if not already assigned, and choose your Snyk OIDC app,. Then click on the pencil next to the displayed Snyk OIDC app. | ||
| 2. Select a **Group**, navigate to the **Applications** tab, click **Assign** **application** if not already assigned, and choose your Snyk OIDC app. Then click the pencil next to the displayed Snyk OIDC app. |
Contributor
There was a problem hiding this comment.
Suggested change
| 2. Select a **Group**, navigate to the **Applications** tab, click **Assign** **application** if not already assigned, and choose your Snyk OIDC app. Then click the pencil next to the displayed Snyk OIDC app. | |
| 2. Select a **Group**, navigate to the **Applications** tab, click **Assign application** if not already assigned, and choose your Snyk OIDC app. Then click the pencil next to the displayed Snyk OIDC app. |
|
|
||
| <figure><img src="../../../../../.gitbook/assets/5 (1).png" alt="Group selected for modicification"><figcaption><p>Group selected for modicification</p></figcaption></figure> | ||
| 3. In the **Edit App Assignment** dialog, add the Snyk org name + role associated with your Okta group (no spaces or capital letter(s)), following the syntax explained in [custom mapping](../) (or [legacy custom mapping](../legacy-custom-mapping.md) if using the legacy mapping option). Example, `snyk:org:*:org_admin`.\\ | ||
| 3. In the **Edit App Assignment** dialog, add the Snyk org name + role associated with your Okta group (no spaces or capital letters), following the syntax explained in [custom mapping](../) (or [legacy custom mapping](../legacy-custom-mapping.md) if using the legacy mapping option). Example, `snyk:org:*:org_admin`.\\ |
Contributor
There was a problem hiding this comment.
Suggested change
| 3. In the **Edit App Assignment** dialog, add the Snyk org name + role associated with your Okta group (no spaces or capital letters), following the syntax explained in [custom mapping](../) (or [legacy custom mapping](../legacy-custom-mapping.md) if using the legacy mapping option). Example, `snyk:org:*:org_admin`.\\ | |
| 3. In the **Edit App Assignment** dialog, add the Snyk org name + role associated with your Okta group (no spaces or capital letters), following the syntax explained in [custom mapping](../) (or [legacy custom mapping](../legacy-custom-mapping.md) if using the legacy mapping option). Example, `snyk:org:*:org_admin`.\ |
|
|
||
| <figure><img src="../../../../../.gitbook/assets/image (158).png" alt="Add assignment"><figcaption><p>Add assignment</p></figcaption></figure> | ||
| 7. Repeat for all required groups and roles that should be assigned. Then verify that the list looks similar to this.\\ | ||
| 7. Repeat for all required groups and roles. Then verify that the list looks similar to this.\\ |
Contributor
There was a problem hiding this comment.
Suggested change
| 7. Repeat for all required groups and roles. Then verify that the list looks similar to this.\\ | |
| 7. Repeat for all required groups and roles. Then verify that the list looks similar to this.\ |
| 1. On the main page of Okta select **Directory** > **Groups**. | ||
| 2. Select a **Group**, navigate to the **Applications** tab, click **Assign** **application** if not already assigned, and choose your Snyk SSO app,. Then click on the pencil next to the displayed Snyk SSO app. | ||
| 3. In the **Edit App Assignment** dialog, add the Snyk Organization slug, and the Organization role name associated with your Okta group (no spaces or capital letters), following the syntax explained in [custom mapping ](../)(or see [legacy custom mapping](../legacy-custom-mapping.md) if you are using that option). | ||
| 2. Select a **Group**, navigate to the **Applications** tab, click **Assign** **application** if not already assigned, and choose your Snyk SSO app. Then click the pencil next to the displayed Snyk SSO app. |
Contributor
There was a problem hiding this comment.
Suggested change
| 2. Select a **Group**, navigate to the **Applications** tab, click **Assign** **application** if not already assigned, and choose your Snyk SSO app. Then click the pencil next to the displayed Snyk SSO app. | |
| 2. Select a **Group**, navigate to the **Applications** tab, click **Assign application** if not already assigned, and choose your Snyk SSO app. Then click the pencil next to the displayed Snyk SSO app. |
| You can create an Organization or join an Organization by invitation. On the **Free** and **Team** plans, you can create up to five Organizations in your Tenant. On the **Enterprise** plan, you can create an unlimited number of Organizations. | ||
|
|
||
| If you have more than one Organization, you can switch between Organizations in the Snyk WebUI or using the CLI. For more details, visit [Manage Organizations](create-and-delete-organizations.md)**.** | ||
| If you have more than one Organization, you can switch between Organizations in the Snyk Web UI or using the CLI. For more details, visit [Manage Organizations](create-and-delete-organizations.md)**.** |
Contributor
There was a problem hiding this comment.
Suggested change
| If you have more than one Organization, you can switch between Organizations in the Snyk Web UI or using the CLI. For more details, visit [Manage Organizations](create-and-delete-organizations.md)**.** | |
| If you have more than one Organization, you can switch between Organizations in the Snyk Web UI or using the CLI. For more details, visit [Manage Organizations](create-and-delete-organizations.md). |
| * **Snyk Open Source**: Enable Reachable vulnerabilities analysis and edit language settings; see [Snyk Open Source - supported languages and package managers](https://app.gitbook.com/s/L7HyJj9FsK1W4pNt8Gzl/supported-languages/supported-languages-package-managers-and-frameworks) for details. | ||
| * **Snyk Code**: Enable Snyk Code; see the [Snyk Code](https://app.gitbook.com/s/BJO0IZx7zB6bOkotxQP2/scan-with-snyk/snyk-code) documentation for details. | ||
| * **Snyk IaC:** Enable Snyk Iac, detecting configuration files, and rules. Select severity levels for configurations scanned. See the [IaC ](https://app.gitbook.com/s/BJO0IZx7zB6bOkotxQP2/scan-with-snyk/snyk-iac/scan-your-iac-source-code)documentation for details. | ||
| * **Snyk IaC:** Enable Snyk IaC, detecting configuration files, and rules. Select severity levels for configurations scanned. See the [IaC ](https://app.gitbook.com/s/BJO0IZx7zB6bOkotxQP2/scan-with-snyk/snyk-iac/scan-your-iac-source-code)documentation for details. |
Contributor
There was a problem hiding this comment.
Suggested change
| * **Snyk IaC:** Enable Snyk IaC, detecting configuration files, and rules. Select severity levels for configurations scanned. See the [IaC ](https://app.gitbook.com/s/BJO0IZx7zB6bOkotxQP2/scan-with-snyk/snyk-iac/scan-your-iac-source-code)documentation for details. | |
| * **Snyk IaC:** Enable Snyk IaC, detecting configuration files, and rules. Select severity levels for configurations scanned. See the [IaC](https://app.gitbook.com/s/BJO0IZx7zB6bOkotxQP2/scan-with-snyk/snyk-iac/scan-your-iac-source-code) documentation for details. |
| * [**Groups**](groups/): A Group encompasses your entire base of Snyk users. You have at least one Snyk Group. Large companies may have multiple Groups with multiple Organizations. | ||
| * [**Groups**](groups/): A Group encompasses your entire base of Snyk users. You have at least one Snyk Group. Large companies can have multiple Groups with multiple Organizations. | ||
| * [**Organizations**](organizations/): An Organization represents a specific area, such as a team, in your business. Organizations can contain multiple Projects. | ||
| * [**Targets**:](https://app.gitbook.com/s/L7HyJj9FsK1W4pNt8Gzl/glossary#target) A Target represents the external resource that Snyk scans, like a repository. One Target can relate to multiple Projects. For example, a Target `https://github.com/examplesnyk/example` contains the Projects `package.json` and `Dockerfile.` |
Contributor
There was a problem hiding this comment.
Suggested change
| * [**Targets**:](https://app.gitbook.com/s/L7HyJj9FsK1W4pNt8Gzl/glossary#target) A Target represents the external resource that Snyk scans, like a repository. One Target can relate to multiple Projects. For example, a Target `https://github.com/examplesnyk/example` contains the Projects `package.json` and `Dockerfile.` | |
| * [**Targets**](https://app.gitbook.com/s/L7HyJj9FsK1W4pNt8Gzl/glossary#target): A Target represents the external resource that Snyk scans, like a repository. One Target can relate to multiple Projects. For example, a Target `https://github.com/examplesnyk/example` contains the Projects `package.json` and `Dockerfile`. |
| * [**Groups**](groups/): A Group encompasses your entire base of Snyk users. You have at least one Snyk Group. Large companies can have multiple Groups with multiple Organizations. | ||
| * [**Organizations**](organizations/): An Organization represents a specific area, such as a team, in your business. Organizations can contain multiple Projects. | ||
| * [**Targets**:](https://app.gitbook.com/s/L7HyJj9FsK1W4pNt8Gzl/glossary#target) A Target represents the external resource that Snyk scans, like a repository. One Target can relate to multiple Projects. For example, a Target `https://github.com/examplesnyk/example` contains the Projects `package.json` and `Dockerfile.` | ||
| * [**Projects**](https://app.gitbook.com/s/BJO0IZx7zB6bOkotxQP2/scan-with-snyk/snyk-projects)**:** A Project is established based on the item that Snyk scans for issues, such as a manifest file. Each Project shows the results of scans. You can configure your Projects to define how to scan for issues in that Project. |
Contributor
There was a problem hiding this comment.
Suggested change
| * [**Projects**](https://app.gitbook.com/s/BJO0IZx7zB6bOkotxQP2/scan-with-snyk/snyk-projects)**:** A Project is established based on the item that Snyk scans for issues, such as a manifest file. Each Project shows the results of scans. You can configure your Projects to define how to scan for issues in that Project. | |
| * [**Projects**](https://app.gitbook.com/s/BJO0IZx7zB6bOkotxQP2/scan-with-snyk/snyk-projects): A Project is established based on the item that Snyk scans for issues, such as a manifest file. Each Project shows the results of scans. You can configure your Projects to define how to scan for issues in that Project. |
| 3. If either the **Vulnerabilities** or **License Violations** boxes are checked, indicate the severity of issues for which Snyk should send alert emails by selecting **All severities** or **Critical and high severity** from the drop-down list. | ||
| 4. To change the default for individual organizations, change the **Vulnerabilities**, **License Violations,** and **Severity** settings next to the Organization name. These settings apply for any individual user who has not updated personal notifications when you create new Organizations in this Group. | ||
| 3. If either the **Vulnerabilities** or **License Violations** boxes are checked, indicate the severity of issues for which Snyk sends alert emails by selecting **All severities** or **Critical and high severity** from the dropdown list. | ||
| 4. To change the default for individual Organizations, change the **Vulnerabilities**, **License Violations,** and **Severity** settings next to the Organization name. These settings apply for any individual user who has not updated personal notifications when you create new Organizations in this Group. |
Contributor
There was a problem hiding this comment.
Suggested change
| 4. To change the default for individual Organizations, change the **Vulnerabilities**, **License Violations,** and **Severity** settings next to the Organization name. These settings apply for any individual user who has not updated personal notifications when you create new Organizations in this Group. | |
| 4. To change the default for individual Organizations, change the **Vulnerabilities**, **License Violations**, and **Severity** settings next to the Organization name. These settings apply for any individual user who has not updated personal notifications when you create new Organizations in this Group. |
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 Platform administration section (114 files).
Part of the per-section writing-style review. Targets the shared base branch
writing-style-review.Consistent changes
Preserved
Frontmatter, GitBook components, HTML/permission tables, links/URLs, image paths, and technical literals are unchanged. SUMMARY.md (navigation) not touched.
Generated with Claude Code