-
Notifications
You must be signed in to change notification settings - Fork 229
docs: apply Snyk writing-style skill to Discover Snyk pages #1367
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: writing-style-review
Are you sure you want to change the base?
Changes from 4 commits
843629f
ec395d7
bc6bc4e
84337ee
be09bcf
18cefa2
ddb84ce
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |||||
|
|
||||||
| {% include "../../../../.gitbook/includes/pilot-guide-navigation.md" %} | ||||||
|
|
||||||
| Review the steps below to configure the Bitbucket integration with Snyk. For more details about setting up the GitHub integration, contact your Snyk account team.\\ | ||||||
| Review the following steps to configure the Bitbucket integration with Snyk. For more details about setting up the integration, contact your Snyk account team.\\ | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ## Generate a BitBucket PAT | ||||||
|
|
||||||
|
|
@@ -35,7 +35,7 @@ Configure the Group-level integration by following these steps: | |||||
| * If relevant, you can also include the Backstage catalog. See the [Backstage file for SCM integrations](https://app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/integrations/scm-integrations/application-context-for-scm-integrations#backstage-file-for-scm-integrations) page for more details. | ||||||
|
|
||||||
| {% hint style="info" %} | ||||||
| After the integration is configured, the Group-level integration shifts to a **Partially connected** status. During the next synchronization, it will transition to the connected state, and the Inventory view will be filled with data from the GitHub source. | ||||||
| After the integration is configured, the Group-level integration shifts to a **Partially connected** status. During the next synchronization, it transitions to the connected state, and the Inventory view fills with data from the Bitbucket source. | ||||||
| {% endhint %} | ||||||
|
|
||||||
| ## Configure the Organization-level integration | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,11 +2,11 @@ | |
|
|
||
| {% include "../../../../.gitbook/includes/pilot-guide-navigation.md" %} | ||
|
|
||
| Review the steps below to configure the GitLab integration with Snyk. For more details about setting up the GitHub integration, contact your Snyk account team. | ||
| Review the following steps to configure the GitLab integration with Snyk. For more details about setting up the integration, contact your Snyk account team. | ||
|
|
||
| ## Generate a GitLab PAT | ||
|
|
||
| Generate a GitHub PAT with the following permissions enabled:\\ | ||
| Generate a GitLab PAT with the following permissions enabled:\\ | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @mikeromard Looking at this the instructions in the Pilot guide are confusing. This is from Group GitLab, but it is asking you to create a GitHub PAT and then select the GitHub integration tile when there is a GitLab one. I can see you and Ann worked on this from the page history, so wondering if you can clarify?
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I didn't author this, but I expect this is just a copy/paste error, and it should say GitLab PAT. |
||
|
|
||
| * `api` | ||
| * `read_api` | ||
|
|
@@ -26,12 +26,12 @@ Configure the Group-level integration by following these steps: | |
|
|
||
| <figure><img src="../../../../.gitbook/assets/image (307).png" alt=""><figcaption></figcaption></figure> | ||
|
|
||
| * Search and select the GitHub integration | ||
| * Search and select the GitLab integration | ||
| * Configure the integration and populate all mandatory fields, including the PAT details. For more details, see the [Integrate GitLab using Snyk Essentials](https://app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/integrations/scm-integrations/group-level-integrations/gitlab-for-snyk-essentials#gitlab-integrate-using-snyk-apprisk) page. | ||
| * If relevant, you can also include the Backstage catalog. See the [Backstage file for SCM integrations](https://app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/integrations/scm-integrations/application-context-for-scm-integrations#backstage-file-for-scm-integrations) page for more details. | ||
|
|
||
| {% hint style="info" %} | ||
| After the integration is configured, the Group-level integration shifts to a **Partially connected** status. During the next synchronization, it will transition to the connected state, and the Inventory view will be filled with data from the GitHub source. | ||
| After the integration is configured, the Group-level integration shifts to a **Partially connected** status. During the next synchronization, it transitions to the connected state, and the Inventory view fills with data from the GitLab source. | ||
| {% endhint %} | ||
|
|
||
| ## Configure the Organization-level integration | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we update the writing-style skill to remove bold from headers?