This repository is home to the Snyk user documentation source files.
If you are an internal Snyk contributor with write access to this repository, you can open a PR to fix issues or make small updates.
- Use a branch rather than a fork, to allow GitBook previews. This makes it easier for the docs team to review your PR.
- Use the workflow in the #request-ux-content Slack channel to request a review of your PR.
- Your commits must be signed.
For larger updates, we prefer that you make the changes in GitBook. Go to our internal writing user documentation page for details.
To ask questions or to report issues to the user docs team, use the workflow in the #request-ux-content Slack channel to contact us.
If you are an external contributor, you can open a PR to fix issues such as typos or broken links. Your commits must be signed.
Before working on larger contributions, contact support to discuss the issue or request with us.
If you want to add an integration to Snyk, apply to become a Snyk partner.
For any security issues or concerns, go to SECURITY.md.