Elastic Security Docs home page: https://www.elastic.co/guide/en/security/current/index.html
Documentation Manager: Janeen Mikell-Straughn (Github: @jmikell821
)
Please view this template for guidance on creating issues: https://github.com/elastic/security-docs/blob/master/.github/ISSUE_TEMPLATE/documentation-issue.md
If you are an Elastic employee and would like to contribute to Elastic Security documentation:
- Please clone and fork the
security-docs
repo. - Open an issue using the appropriate template.
- Check out the
main
branch and fetch the latest changes. - Check out a new branch and make your changes.
- Save your changes and open a pull request.
- Add the
[@elastic/security-docs](https://github.com/orgs/elastic/teams/security-docs)
team and any other appropriate members as reviewers. - Add the appropriate release version label, backport version label if appropriate, and team label to the PR.
- Once the docs team approves all changes, you can merge it. If a backport version label was added to a PR for stack versions 7.14.0 and newer, mergify will automatically open a backport PR.
- Merge the backport PR once it passes all CI checks.
Once the PR is opened, and the build complete, the changes can be previewed via this URL (replace <YOUR_PR_NUMBER_HERE>
with the PR number):
https://security-docs_<YOUR_PR_NUMBER_HERE>.docs-preview.app.elstc.co/guide/en/security/master