Skip to content

Commit

Permalink
update top-level docs for Code (#1279)
Browse files Browse the repository at this point in the history
  • Loading branch information
khorne3 authored Dec 18, 2023
1 parent 350bc2e commit 1b0cc57
Show file tree
Hide file tree
Showing 25 changed files with 163 additions and 303 deletions.
2 changes: 1 addition & 1 deletion docs/kb/semgrep-cloud-platform/missing-pr-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ If you are using a self-hosted version of GitHub (GitHub Enterprise) or GitLab (

GitHub relies on the Semgrep GitHub app to make comments on code. To receive comments on a project, ensure that you have performed the following steps:

* You have [onboarded](/docs/semgrep-code/getting-started/#option-b-adding-a-repository-from-github-gitlab-or-bitbucket) the project to Semgrep Cloud Platform.
* You have [onboarded](/docs/semgrep-code/getting-started/) the project to Semgrep Cloud Platform.
* You have configured your GitHub app with permissions for all repositories that are scanned by Semgrep Cloud Platform. See [Enabling GitHub pull request comments](/docs/semgrep-cloud-platform/github-pr-comments/) for details.

### GitLab and Bitbucket
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ GitHub, GitLab, and BitBucket SCMs are compatible with the above mentioned CI pr

To set up the CI job and connect with Semgrep Cloud Platform:

1. Sign in to [Semgrep Cloud Platform](https://semgrep.dev/login). See [Signing in to Semgrep Cloud Platform](/semgrep-code/getting-started/#signing-in-to-semgrep-cloud-platform) for details on requested repository permissions and access.
1. Sign in to [Semgrep Cloud Platform](https://semgrep.dev/login). See [Signing in to Semgrep Cloud Platform](/semgrep-code/getting-started/) for details on requested repository permissions and access.
2. Click **[Projects](https://semgrep.dev/orgs/-/projects)** > **Scan New Project** > **Run Scan in CI**.
3. Select your CI provider from the menu.
4. Optional: Some providers can ask you to select your organization if applicable to your SCM tool.
Expand Down
2 changes: 1 addition & 1 deletion docs/semgrep-cloud-platform/asana.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The Semgrep Asana integration allows you to create Asana tickets based on your S

:::info Prerequisites
* Your Asana user must be able to approve an OAuth integration with admin level privileges.
* Asana can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/#signing-in-to-semgrep-cloud-platform) to set up your Asana integration.
* Asana can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/) to set up your Asana integration.
* To create tickets, you must [add or onboard the project](/semgrep-code/getting-started/#option-b-adding-a-repository-from-github-gitlab-or-bitbucket) (repository) to Semgrep Cloud Platform for scanning.
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/semgrep-cloud-platform/bitbucket-pr-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Semgrep can create **pull request (PR) comments** in your Bitbucket repository.

:::info Prerequisites
* You must have a Bitbucket Cloud Free, Standard, or Premium plan. Bitbucket Data Center is not supported.
* Bitbucket PR comments can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/#signing-in-to-semgrep-cloud-platform) to set up Slack notifications.
* To receive alerts and notifications, you must [add or onboard a project](/semgrep-code/getting-started/#option-b-adding-a-repository-from-github-gitlab-or-bitbucket) (repository) to Semgrep Cloud Platform for scanning.
* Bitbucket PR comments can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/) to set up Slack notifications.
* To receive alerts and notifications, you must [add or onboard a project](/semgrep-code/getting-started/) (repository) to Semgrep Cloud Platform for scanning.
:::


Expand Down
4 changes: 2 additions & 2 deletions docs/semgrep-cloud-platform/email.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Object.entries(frontMatter).filter(
# Receiving email notifications

:::info Prerequisites
* Email notifications can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/#signing-in-to-semgrep-cloud-platform) to set up Slack notifications.
* To receive alerts and notifications, you must [add or onboard the project](/semgrep-code/getting-started/#option-b-adding-a-repository-from-github-gitlab-or-bitbucket) (repository) to Semgrep Cloud Platform for scanning.
* Email notifications can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/) to set up Slack notifications.
* To receive alerts and notifications, you must [add or onboard the project](/semgrep-code/getting-started/) (repository) to Semgrep Cloud Platform for scanning.
:::

Receive Semgrep findings through email.
Expand Down
4 changes: 2 additions & 2 deletions docs/semgrep-cloud-platform/jira.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ The Semgrep Jira integration allows you to create Jira tickets based on your Sem
:::info Prerequisites
* You must have a **Jira Cloud** plan. Jira Data Center (self-managed, or on-prem) is not supported.
* Your Jira user must be able to create a Jira API key with admin level privileges.
* Jira can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/#signing-in-to-semgrep-cloud-platform) to set up your Jira integration.
* To create tickets, you must [add or onboard the project](/semgrep-code/getting-started/#option-b-adding-a-repository-from-github-gitlab-or-bitbucket) (repository) to Semgrep Cloud Platform for scanning.
* Jira can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/) to set up your Jira integration.
* To create tickets, you must [add or onboard the project](/semgrep-code/getting-started/) (repository) to Semgrep Cloud Platform for scanning.
:::

To integrate Jira, follow these steps:
Expand Down
4 changes: 2 additions & 2 deletions docs/semgrep-cloud-platform/linear.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ The Semgrep Linear integration allows you to create Linear tickets based on your

:::info Prerequisites
* Your Linear user must be able to approve an OAuth integration with admin level privileges.
* Linear can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/#signing-in-to-semgrep-cloud-platform) to set up your Linear integration.
* To create tickets, you must [add or onboard the project](/semgrep-code/getting-started/#option-b-adding-a-repository-from-github-gitlab-or-bitbucket) (repository) to Semgrep Cloud Platform for scanning.
* Linear can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/) to set up your Linear integration.
* To create tickets, you must [add or onboard the project](/semgrep-code/getting-started/) (repository) to Semgrep Cloud Platform for scanning.
:::

To integrate Linear, follow these steps:
Expand Down
2 changes: 1 addition & 1 deletion docs/semgrep-cloud-platform/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Semgrep Cloud Platform can send notifications through the following channels:

:::info
* Alerts and notifications can only be enabled through Semgrep Cloud Platform (SCP). [Sign up or sign in to Semgrep Cloud Platform](https://semgrep.dev/login).
* To receive alerts and notifications, you must [add or onboard the project](/semgrep-code/getting-started/#option-b-adding-a-repository-from-github-gitlab-or-bitbucket) (repository) to Semgrep Cloud Platform for scanning.
* To receive alerts and notifications, you must [add or onboard the project](/semgrep-code/getting-started/) (repository) to Semgrep Cloud Platform for scanning.
:::

## Finding available alert and notification channels
Expand Down
4 changes: 2 additions & 2 deletions docs/semgrep-cloud-platform/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Prefer "Semgrep Slack app" over "Semgrep Slack integration" or "Slack integratio
<!-- <ProcedureIntegrateSlack /> -->

:::info Prerequisites
* Slack notifications can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/#signing-in-to-semgrep-cloud-platform) to set up Slack notifications.
* To receive alerts and notifications, you must [add or onboard the project](/semgrep-code/getting-started/#option-b-adding-a-repository-from-github-gitlab-or-bitbucket) (repository) to Semgrep Cloud Platform for scanning.
* Slack notifications can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/) to set up Slack notifications.
* To receive alerts and notifications, you must [add or onboard the project](/semgrep-code/getting-started/) (repository) to Semgrep Cloud Platform for scanning.
* You must be a Slack **Workspace Owner** to set up the Semgrep Slack app.
:::

Expand Down
2 changes: 1 addition & 1 deletion docs/semgrep-cloud-platform/ticketing.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ Semgrep Cloud Platform can create tickets in the following systems:

:::info
* Ticketing integrations can only be enabled through Semgrep Cloud Platform (SCP). [Sign up or sign in to Semgrep Cloud Platform](https://semgrep.dev/login).
* To receive alerts and notifications, you must [add or onboard the project](/semgrep-code/getting-started/#option-b-adding-a-repository-from-github-gitlab-or-bitbucket) (repository) to Semgrep Cloud Platform for scanning.
* To receive alerts and notifications, you must [add or onboard the project](/semgrep-code/getting-started/) (repository) to Semgrep Cloud Platform for scanning.
:::
4 changes: 2 additions & 2 deletions docs/semgrep-cloud-platform/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Object.entries(frontMatter).filter(
# Enabling webhooks

:::info Prerequisites
* Webhooks can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/#signing-in-to-semgrep-cloud-platform) to set up webhooks.
* To receive alerts and notifications, you must [add or onboard a project](/semgrep-code/getting-started/#option-b-adding-a-repository-from-github-gitlab-or-bitbucket) (repository) to Semgrep Cloud Platform for scanning.
* Webhooks can only be enabled through Semgrep Cloud Platform (SCP). [Create an account](/semgrep-code/getting-started/) to set up webhooks.
* To receive alerts and notifications, you must [add or onboard a project](/semgrep-code/getting-started/) (repository) to Semgrep Cloud Platform for scanning.
:::

Webhooks are a generic method for Semgrep Cloud Platform to post JSON-formatted findings after each scan to your URL endpoint.
Expand Down
Loading

0 comments on commit 1b0cc57

Please sign in to comment.