Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
joepeeples committed May 21, 2024
1 parent cdda1d2 commit 0a8888b
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,33 @@

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

If you are an Elastic employee and would like to contribute to Elastic Security documentation:
If you're an Elastic employee, you can open an issue using the appropriate [template](https://github.com/elastic/security-docs/issues/new/choose). To contribute directly to Elastic Security documentation:

1. Please clone and fork the `security-docs` repo.
2. Open an issue using the appropriate [template](https://github.com/elastic/security-docs/issues/new/choose).
3. Check out the `main` branch and fetch the latest changes.
4. Check out a new branch and make your changes.
5. Save your changes and open a pull request.
6. Add the [@elastic/security-docs](https://github.com/orgs/elastic/teams/security-docs) team and any other appropriate members as reviewers.
7. Add the appropriate release version label, backport version label if appropriate, and team label to 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.
1. Please fork and clone the `security-docs` repo.
1. Check out the `main` branch and fetch the latest changes.
1. Check out a new branch and make your changes.
1. Save your changes and open a pull request.
1. Add the [@elastic/security-docs](https://github.com/orgs/elastic/teams/security-docs) team and any other appropriate members as reviewers.
1. Add the appropriate release version label, backport version label if appropriate, and team label to the PR.
1. 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.
1. 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.

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):
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.

0 comments on commit 0a8888b

Please sign in to comment.