This repository is home to the Snyk user documentation source files.
If you are an internal Snyk contributor with write access to this repository, draft your content here in GitHub and then submit it to the Docs team with the /ship-it Slack workflow. /ship-it is the single intake point for all documentation and release-notification requests: it creates the Jira ticket for you and sends you a confirmation DM with tracking links.
Before you run /ship-it, complete these steps so the submission does not fail partway through:
- Confirm you have write access to this repository.
- Connect Atlassian to Slack, which is required for Jira ticket creation.
- Draft your content in GitHub and open a pull request. Use a branch rather than a fork, to allow GitBook previews.
- Follow the
snyk-docs-writing-rulesskill while drafting. - Sign your commits.
- Update
SUMMARY.mdif you are adding new pages.
Then run /ship-it from anywhere in Slack, or from the Ship It app in your sidebar. Have your pull request URL ready and complete all the fields in one sitting, because the multi-step form does not save partial progress.
For details on the process, go to the internal writing user documentation page.
To ask questions or to report issues to the user docs team, use /ship-it. The legacy submission forms remain available only as a fallback under Workflows → "Contact the Docs team."
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.