Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 2.64 KB

README.md

File metadata and controls

53 lines (34 loc) · 2.64 KB
Raw

Elastic Security docs

Elastic Security Docs home page: https://www.elastic.co/guide/en/security/current/index.html

Serverless docs: https://docs.elastic.co/serverless/security/what-is-security-serverless

Documentation Manager: Janeen Roberts (Github: @jmikell821)

Contributing to Elastic Security docs

You can open an issue using the appropriate template.

Note

Please report any known issues that need to be documented by creating an issue in our private repo using the known issue template.

To contribute directly to Elastic Security documentation:

  1. Please fork and clone the security-docs repo.
  2. Check out the main branch and fetch the latest changes.
  3. Check out a new branch and make your changes.
  4. Save your changes and open a pull request.
  5. Add all appropriate Github users as reviewers.
  6. Add the appropriate release version label, backport version label if appropriate, and team label to the PR.
  7. If your PR changes any serverless docs content, add the label ci:doc-build to generate a preview of the serverless docs on the PR.
  8. 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.
  9. Merge the backport PR once it passes all CI checks.

Preview documentation changes

When you open a pull request, preview links are automatically added as a comment in the PR. Once the CI check builds successfully, the links will be live and you can click them to preview your changes.

For stateful docs, you also might want to add targeted links to help reviewers find specific pages related to your PR. Preview URLs include the following pattern (replace <YOUR_PR_NUMBER_HERE> with the PR number):

https://security-docs_bk_<YOUR_PR_NUMBER_HERE>.docs-preview.app.elstc.co/guide/en/security/master/

Note

Serverless docs previews don't allow targeted links, because the id in the URL changes with each rebuild.

License

Shield: CC BY-NC-ND 4.0

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivs 4.0 International License.

CC BY-NC-ND 4.0