Skip to content

Commit

Permalink
Merge branch 'main' into feat/generate-change-log-script
Browse files Browse the repository at this point in the history
  • Loading branch information
tinygrasshopper committed May 31, 2024
2 parents 96bb42c + bb4e6a2 commit ce68e9a
Show file tree
Hide file tree
Showing 82 changed files with 62,449 additions and 14,457 deletions.
76,322 changes: 62,065 additions & 14,257 deletions docs/.gitbook/assets/rest-spec.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Start using Snyk

<table data-header-hidden><thead><tr><th></th><th width="164.33333333333331"></th><th width="188"></th><th></th></tr></thead><tbody><tr><td>​<a href="getting-started/">Getting started</a><br>Start running Snyk to secure your code</td><td><a href="enterprise-configuration/">Enterprise configuration</a><br>Use Snyk in an enterprise system</td><td><a href="implement-snyk/">Implement Snyk</a><br>Set up Snyk to run in your business</td><td><a href="scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/">Supported languages</a><br>Match your language and framework to Snyk</td></tr></tbody></table>
<table data-header-hidden><thead><tr><th></th><th width="164.33333333333331"></th><th width="188"></th><th></th></tr></thead><tbody><tr><td>​<a href="getting-started/">Getting started</a><br>Start running Snyk to secure your code</td><td><a href="enterprise-configuration/">Enterprise configuration</a><br>Use Snyk in an enterprise system</td><td><a href="implement-snyk/">Implement Snyk</a><br>Set up Snyk to run in your business</td><td><a href="getting-started/supported-languages-and-frameworks/">Supported languages</a><br>Match your language and framework to Snyk</td></tr></tbody></table>

## Integrate with Snyk <a href="#explore-snyk-products" id="explore-snyk-products"></a>

Expand Down
30 changes: 15 additions & 15 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
* [Set up an integration](getting-started/quickstart/set-up-an-integration.md)
* [Import a Project](getting-started/quickstart/import-a-project.md)
* [View Snyk scan results](getting-started/quickstart/view-snyk-scan-results.md)
* [Supported languages and frameworks](scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/README.md)
* [Supported languages and frameworks](getting-started/supported-languages-and-frameworks/README.md)
* [Technical specifications](getting-started/supported-languages-and-frameworks/technical-specifications.md)
* [.NET](scan-with-snyk/supported-languages-and-frameworks/.net/README.md)
* [Improved .NET scanning](getting-started/supported-languages-frameworks-and-feature-availability-overview/.net/improved-.net-scanning.md)
* [.NET](getting-started/supported-languages-and-frameworks/.net/README.md)
* [Improved .NET scanning](getting-started/supported-languages-and-frameworks/.net/improved-.net-scanning.md)
* [Best practices for .NET](getting-started/supported-languages-and-frameworks/.net/best-practices-for-.net.md)
* [Troubleshooting .NET](getting-started/supported-languages-and-frameworks/.net/troubleshooting-.net.md)
* [Apex](getting-started/supported-languages-and-frameworks/apex.md)
Expand Down Expand Up @@ -399,15 +399,6 @@
* [Jira integration](integrate-with-snyk/jira-and-slack-integrations/jira-integration.md)
* [Slack app](integrate-with-snyk/jira-and-slack-integrations/slack-app.md)
* [Slack integration](integrate-with-snyk/jira-and-slack-integrations/slack-integration.md)
* [Package repository integrations](integrate-with-snyk/package-repository-integrations/README.md)
* [Artifactory Package Repository connection setup](integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/README.md)
* [Artifactory Registry for Maven](integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md)
* [Artifactory Registry for npm](integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-npm.md)
* [Nexus Repository Manager connection setup](integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/README.md)
* [Nexus Repository Manager for Maven](integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-maven.md)
* [Nexus Repository Manager for npm](integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-npm.md)
* [npm Teams and npm Enterprise integration](integrate-with-snyk/package-repository-integrations/npm-teams-and-npm-enterprise-integration.md)
* [Private gem sources for Ruby configuration](integrate-with-snyk/package-repository-integrations/private-gem-sources-for-ruby-configuration.md)
* [Cloud platforms integrations](integrate-with-snyk/cloud-platforms-integrations/README.md)
* [AWS Integration](integrate-with-snyk/cloud-platforms-integrations/aws-integration/README.md)
* [AWS Integration: Web UI](integrate-with-snyk/cloud-platforms-integrations/aws-integration/aws-integration-web-ui/README.md)
Expand Down Expand Up @@ -491,11 +482,20 @@
* [Scan open-source libraries and licenses](scan-with-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/README.md)
* [Open-source license compliance](scan-with-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/open-source-license-compliance.md)
* [Snyk License Compliance Management](scan-with-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/snyk-license-compliance-management.md)
* [Gatekeeper plugins](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/README.md)
* [Artifactory Gatekeeper Plugin](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/artifactory-gatekeeper-plugin.md)
* [Nexus Repository Manager Gatekeeper Plugin](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md)
* [Package repository integrations](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/README.md)
* [Artifactory Package Repository connection setup](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/README.md)
* [Artifactory Registry for Maven](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-maven.md)
* [Artifactory Registry for npm](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/artifactory-registry-for-npm.md)
* [Nexus Repository Manager connection setup](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/README.md)
* [Nexus Repository Manager for Maven](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-maven.md)
* [Nexus Repository Manager for npm](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/nexus-repository-manager-for-npm.md)
* [npm Teams and npm Enterprise integration](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/npm-teams-and-npm-enterprise-integration.md)
* [Private gem sources for Ruby configuration](scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/private-gem-sources-for-ruby-configuration.md)
* [Manage vulnerabilities](scan-with-snyk/snyk-open-source/manage-vulnerabilities/README.md)
* [Fix your vulnerabilities](scan-with-snyk/snyk-open-source/manage-vulnerabilities/fix-your-vulnerabilities.md)
* [Gatekeeper plugins](scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/README.md)
* [Artifactory Gatekeeper Plugin](scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/artifactory-gatekeeper-plugin.md)
* [Nexus Repository Manager Gatekeeper Plugin](scan-using-snyk/snyk-open-source/manage-vulnerabilities/gatekeeper-plugins/nexus-repository-manager-gatekeeper-plugin.md)
* [Vulnerability fix types](scan-with-snyk/snyk-open-source/manage-vulnerabilities/vulnerability-fix-types.md)
* [Upgrade package versions to fix vulnerabilities](scan-with-snyk/snyk-open-source/manage-vulnerabilities/upgrade-package-versions-to-fix-vulnerabilities.md)
* [Snyk patches to fix vulnerabilities](scan-with-snyk/snyk-open-source/manage-vulnerabilities/snyk-patches-to-fix-vulnerabilities.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/enterprise-configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Snyk has a number of tools and processes that help secure your entire software d
For users who are evaluating Snyk or planning an enterprise deployment, and for most programming languages, Snyk recommends integrating with a Git repository to get started.

{% hint style="info" %}
The tool that best serves your tech stack, environment, and workflow depends on your individual circumstances. See [Supported languages and frameworks ](../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/)for the guide specific to your language for more details.
The tool that best serves your tech stack, environment, and workflow depends on your individual circumstances. See [Supported languages and frameworks ](../getting-started/supported-languages-and-frameworks/)for the guide specific to your language for more details.
{% endhint %}

To learn more about choosing the best integration points within the software development lifecycle for you and for your team, at their current level of security maturity, see [Integrating Snyk at your company](https://learn.snyk.io/lesson/integrate-snyk-at-your-company/).
Expand Down
2 changes: 1 addition & 1 deletion docs/enterprise-configuration/snyk-broker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Snyk Broker is an open-source tool that acts as a proxy between Snyk and special

Snyk Broker is hosted on [GitHub](https://github.com/snyk/broker) and published as a set of Docker images for specific integrations. Snyk provides a [Helm Chart](https://github.com/snyk/snyk-broker-helm) to deploy Snyk Broker if you are using Kubernetes. To deploy Broker, you must install and configure an integration.

You can install and configure using [Helm](install-and-configure-snyk-broker/install-and-configure-broker-using-helm.md) or [Docker](install-and-configure-snyk-broker/install-and-configure-broker-using-docker.md). You can install using Docker to run the Snyk Broker Client or run npm `install snyk-broker`. Snyk recommends using Helm as the simplest way to deploy Snyk Broker.&#x20;
You can install and configure using [Helm](install-and-configure-snyk-broker/install-and-configure-broker-using-helm.md) or [Docker](install-and-configure-snyk-broker/install-and-configure-broker-using-docker.md). You can install using Docker to run the Snyk Broker Client or run `npm install snyk-broker`. Snyk recommends using Helm as the simplest way to deploy Snyk Broker.&#x20;

## **Integrations with Snyk Broker**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For more information, see [Plans and pricing](https://snyk.io/plans).

Before installing, review the [prerequisites](./) and the general instructions for installation using [Helm](../install-and-configure-broker-using-helm.md).

For information about non-brokered integration with Artifactory Repository see [Artifactory Repository setup](../../../../integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/). For information about brokered integration with Artifactory Container Registry see [Snyk Broker -Container Registry Agent](https://docs.snyk.io/snyk-admin/snyk-broker/snyk-broker-container-registry-agent).
For information about non-brokered integration with Artifactory Repository see [Artifactory Repository setup](../../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/). For information about brokered integration with Artifactory Container Registry see [Snyk Broker -Container Registry Agent](https://docs.snyk.io/snyk-admin/snyk-broker/snyk-broker-container-registry-agent).

To use this chart, you must first add the Snyk Broker Helm Chart by adding the repo:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Before installing, review the [prerequisites](./) and the general instructions f

This integration is useful to ensure a secure connection with your on-premise Artifactory Repository deployment.

For information about non-brokered integration with Artifactory Repository see [Artifactory Repository setup](../../../../integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/). For information about brokered integration with Artifactory Container Registry see [Snyk Broker -Container Registry Agent](https://docs.snyk.io/snyk-admin/snyk-broker/snyk-broker-container-registry-agent).
For information about non-brokered integration with Artifactory Repository see [Artifactory Repository setup](../../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/). For information about brokered integration with Artifactory Container Registry see [Snyk Broker -Container Registry Agent](https://docs.snyk.io/snyk-admin/snyk-broker/snyk-broker-container-registry-agent).

## Configure Broker to be used for Artifactory Registry

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Integration with Nexus Repository Manager is available only for Enterprise plans
For more information, see [Plans and pricing](https://snyk.io/plans).
{% endhint %}

For information about non-brokered integration with Nexus Repository Manager including supported environments and versions and user permissions, see [Nexus Repository Manager setup](../../../../integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/). For information about brokered integration with Artifactory or Nexus Container Registry see [Snyk Broker -Container Registry Agent](../../snyk-broker-container-registry-agent/).
For information about non-brokered integration with Nexus Repository Manager including supported environments and versions and user permissions, see [Nexus Repository Manager setup](../../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/). For information about brokered integration with Artifactory or Nexus Container Registry see [Snyk Broker -Container Registry Agent](../../snyk-broker-container-registry-agent/).

## Nexus 3 Helm installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Before installing, review the [prerequisites](./) and the general instructions f

This integration is useful to ensure a secure connection with your on-premise Nexus Repository Manager deployment.

For information about non-brokered integration with Nexus Repository Manager including supported environments and versions and user permissions, see [Nexus Repository Manager setup](../../../../integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/). For information about brokered integration with Nexus Container Registry see [Snyk Broker -Container Registry Agent](../../snyk-broker-container-registry-agent/).
For information about non-brokered integration with Nexus Repository Manager including supported environments and versions and user permissions, see [Nexus Repository Manager setup](../../../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/). For information about brokered integration with Nexus Container Registry see [Snyk Broker -Container Registry Agent](../../snyk-broker-container-registry-agent/).

## Configure Broker to be used for Nexus plugins

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ For code repository (SCM) integrations, a Broker token can be generated using th
1. Navigate to the Snyk API v1 documentation and follow the example under "Set up a broker for an existing integration" within the [Integrations API](https://snyk.docs.apiary.io/#reference/integrations/integration/update-existing-integration) or contact [Snyk support](https://support.snyk.io/hc/en-us/requests/new).
2. Verify the Broker token is generated in the Snyk Web UI under the specified SCM integration. by selecting **Settings** > **Integrations** for that specific integration to see the Broker token.

For [Artifactory Repository](../../integrate-with-snyk/package-repository-integrations/artifactory-package-repository-connection-setup/) and [Nexus Repository Manager](../../integrate-with-snyk/package-repository-integrations/nexus-repository-manager-connection-setup/) brokered instances or [Jira](install-and-configure-snyk-broker/jira-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-jira.md) integration, you can generate a Broker token in the Snyk UI or contact [Snyk support](https://support.snyk.io/hc/en-us/requests/new).
For [Artifactory Repository](../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/artifactory-package-repository-connection-setup/) and [Nexus Repository Manager](../../scan-using-snyk/snyk-open-source/scan-open-source-libraries-and-licenses/package-repository-integrations/nexus-repository-manager-connection-setup/) brokered instances or [Jira](install-and-configure-snyk-broker/jira-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-jira.md) integration, you can generate a Broker token in the Snyk UI or contact [Snyk support](https://support.snyk.io/hc/en-us/requests/new).

1. Select **Settings** > **Integrations** for that specific integration to generate the Broker token.
2. After the Broker token is generated, under the integration, the notification from this screen correctly displays **Could not connect to…**, as you have not yet installed and configured the client.
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Running Snyk from the command line.

The Snyk tech stacks that are supported depend on the Snyk product you use:

* **Snyk Open Source** and **Snyk Code**: see [Supported languages and frameworks](../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/).
* **Snyk Open Source** and **Snyk Code**: see [Supported languages and frameworks](supported-languages-and-frameworks/).
* **Snyk Container**: see [Supported operating system distributions](../scan-with-snyk/snyk-container/how-snyk-container-works/supported-operating-system-distributions.md).
* **Snyk Infrastructure as Code**: see [Supported IaC and cloud providers](../scan-with-snyk/snyk-iac/supported-iac-languages-cloud-providers-and-cloud-resources/).

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This quickstart helps you with these basic tasks in the Snyk application:

{% hint style="info" %}
Before starting, check that the code in your repositories matches Snyk's [supported languages and frameworks](../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/).
Before starting, check that the code in your repositories matches Snyk's [supported languages and frameworks](../supported-languages-and-frameworks/).
{% endhint %}

1. [Create a Snyk account](create-or-log-in-to-a-snyk-account.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/snyk-release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Not all features follow all these stages, and timelines for each feature to move
* [Git repository cloning](../snyk-admin/snyk-preview.md#enable-git-repository-cloning)
* [Fix code vulnerabilities automatically](../scan-with-snyk/snyk-code/manage-code-vulnerabilities/fix-code-vulnerabilities-automatically.md)
* [Snyk broker commit signing](../enterprise-configuration/snyk-broker/snyk-broker-commit-signing.md)
* [Improved .NET scanning](supported-languages-frameworks-and-feature-availability-overview/.net/improved-.net-scanning.md)
* [Improved .NET scanning](supported-languages-and-frameworks/.net/improved-.net-scanning.md)

## General Availability

Expand Down
Loading

0 comments on commit ce68e9a

Please sign in to comment.