docs: remove Snyk 2.0 Early Access hints and fix stale links (DOCT-2626) - #1621
Conversation
- Update link in snyk-release-process.md to point to navigate-the-snyk-web-ui - Remove redundant "Snyk 2.0 (Early Access)" hint blocks from 6 pages; all have nav_context: new frontmatter which renders the reusable banner Co-Authored-By: Claude Sonnet 4.6 <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. |
| * Reports | ||
| * [Repositories tested in CI/CD report](https://app.gitbook.com/s/BJO0IZx7zB6bOkotxQP2/prevent/analytics/reports-tab/prevention-reports#repositories-tested-in-ci-cd-report) | ||
| * [Snyk 2.0 platform improvements](snyk-2.0-platform-improvements.md) | ||
| * [Navigate the Snyk Web UI](../navigate-the-snyk-web-ui.md) |
There was a problem hiding this comment.
Issue: Every other entry in this list names a feature; this one names a docs page.
Fix: * [Snyk 2.0 platform navigation](../navigate-the-snyk-web-ui.md)
There was a problem hiding this comment.
don't apply the name suggested in this fix, it is not aligned with the ticket scope of removing Snyk 2.0 mentions
|
|
||
| If you are an existing user, you can switch between the new and classic navigation at any time using the toggle in your user profile menu. For more information, visit [Snyk 2.0 platform improvements](https://app.gitbook.com/s/L7HyJj9FsK1W4pNt8Gzl/snyk-2.0-platform-improvements). | ||
| {% endhint %} | ||
|
|
There was a problem hiding this comment.
Issue: Two consecutive blank lines left where the hint was.
|
|
||
| If you are an existing user, you can switch between the new and classic navigation at any time using the toggle in your user profile menu. For more information, visit [Snyk 2.0 platform improvements](https://app.gitbook.com/s/L7HyJj9FsK1W4pNt8Gzl/snyk-2.0-platform-improvements). | ||
| {% endhint %} | ||
|
|
There was a problem hiding this comment.
Issue: Two consecutive blank lines left where the hint was.
| Snyk 2.0 introduces UI enhancements to the platform navigation and is available in Early Access. This is being rolled out gradually, so not all users see the new navigation at the same time. | ||
|
|
||
| If you are an existing user, you can switch between the new and classic navigation at any time using the toggle in your user profile menu. For more information, visit [Snyk 2.0 platform improvements](https://app.gitbook.com/s/L7HyJj9FsK1W4pNt8Gzl/snyk-2.0-platform-improvements). | ||
| {% endhint %} | ||
|
|
There was a problem hiding this comment.
Issue: Two consecutive blank lines left where the hint was.
| @@ -23,15 +23,6 @@ Here is a list of all the available inventory tabs: | |||
|
|
|||
| Each inventory tab may include different counts of assets and scanned artifacts, depending on the grouping context. Otherwise, all columns and data manipulation features are the same on each inventory layout. | |||
There was a problem hiding this comment.
Issue: "may include" — ambiguous modal.
Proposed: "Each inventory tab can include different counts..."
| @@ -34,12 +34,3 @@ At the Organization level, select **Settings** to manage Organization settings a | |||
| * **Notifications**: See the [Manage notifications](../manage-notifications.md) page for details. | |||
| * **Snyk Preview**: See the [Snyk Preview page](../snyk-preview.md) for details. | |||
|
|
|||
There was a problem hiding this comment.
Issue: File now ends with a stray blank line.
Fix: Trim to a single trailing newline.
| * **Notifications**: See the [Manage notifications](../manage-notifications.md) page for details. | ||
| * **Snyk Preview**: See the [Snyk Preview page](../snyk-preview.md) for details. |
There was a problem hiding this comment.
Issue: "See the ... page" — style is "visit," not "see," when pointing to a page.
Fix: "Visit the Manage notifications page for details." Same for Snyk Preview.
| @@ -41,12 +41,3 @@ Users with Group access can view data for the Organizations associated with thos | |||
|
|
|||
| Snyk restricts access based on Organization-level permissions in both predefined and custom roles. | |||
|
|
|||
There was a problem hiding this comment.
Issue: File now ends with a stray blank line.
Fix: Trim to a single trailing newline.
| @@ -20,12 +20,3 @@ For both dependencies and licenses, you can filter by Project or other filter cr | |||
| Results from the Dockerfile Project type are filtered out by default in the filter criteria as they can result in duplication of results from scans of the images resulting from building the Dockerfiles. To match results from [AP](https://app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/snyk-api/reference/reporting-api-v1)I calls, either filter out Dockerfiles from the API results or turn on Dockfiles in the Project type column of the filter. | |||
| {% endhint %} | |||
|
|
|||
There was a problem hiding this comment.
Issue: File now ends with a stray blank line.
Fix: Trim to a single trailing newline.
| @@ -20,12 +20,3 @@ For both dependencies and licenses, you can filter by Project or other filter cr | |||
| Results from the Dockerfile Project type are filtered out by default in the filter criteria as they can result in duplication of results from scans of the images resulting from building the Dockerfiles. To match results from [AP](https://app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/snyk-api/reference/reporting-api-v1)I calls, either filter out Dockerfiles from the API results or turn on Dockfiles in the Project type column of the filter. | |||
There was a problem hiding this comment.
Issue: Link markup splits the word API ([AP](...)I calls), and "Dockfiles" is a typo.
Fix: "To match results from Reporting API calls, either filter out Dockerfiles from the API results or turn on Dockerfiles in the Project type column of the filter."
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
|
Rebased onto
Left Ready for re-review. |
…-snyk-2.0-page # Conflicts: # discover-snyk/getting-started/snyk-release-process.md # scan-fix-and-prevent/fix/manage-asset-inventory/README.md # scan-fix-and-prevent/manage-risk/analytics/README.md # scan-fix-and-prevent/manage-risk/dependencies-and-licenses/README.md
46a0d10 to
30d0913
Compare
3 participants
Summary
snyk-release-process.mdfrom the deleted page tonavigate-the-snyk-web-ui{% hint style="info" %}"Snyk 2.0 (Early Access)" blocks from 6 pages acrossscan-fix-and-prevent/andplatform-administration/; all 6 already havenav_context: newfrontmatter which renders the reusable banner (added in docs: add new-navigation-banner to scan-fix-and-prevent classic pages (DOCT-2626 Phase B) #1582)snyk-2.0-platform-improvements.mdsource file and SUMMARY entry will be removed automatically via Git Sync when CR 28 is mergedTest plan
grep -r "Snyk 2.0" .returns onlywhats-new.md,SUMMARY.md, andsnyk-2.0-platform-improvements.md(all auto-managed or deleted via CR 28)grep -r "snyk-2.0-platform-improvements" .returns onlywhats-new.mdandSUMMARY.mdnav_context: newbanner correctly in GitBook preview🤖 Generated with Claude Code
Note
Low Risk
Documentation-only edits with no product, auth, or data-handling impact.
Overview
Documentation cleanup for the rolled-out Snyk Web UI navigation: removes duplicate “Snyk 2.0 (Early Access)” info hints from six pages in platform administration and scan/fix/prevent, since those pages already use
nav_context: newfor the shared navigation banner.snyk-release-process.mdreplaces the broken Early Access features link to deleted “Snyk 2.0 platform improvements” withNavigate the Snyk Web UI.Minor copy fixes on
dependencies-and-licenses/README.md: corrects “Reporting API” link text and Dockerfile filter wording (typos).group-and-organization-settings.mdtweaks Notifications/Preview bullets from “See” to “Visit”.manage-asset-inventory/README.mdchanges “may” to “can” in one sentence.Reviewed by Cursor Bugbot for commit 30d0913. Bugbot is set up for automated code reviews on this repo. Configure here.