diff --git a/README.md b/README.md index 3f13402ecd..c23d36f7ce 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,24 @@ -# docs-content +# Elastic Docs Content -This repo contains most of our Elastic Serverless documentation, including: - -- [Overview content](https://www.elastic.co/docs/current/serverless) -- [Elasticsearch](https://www.elastic.co/docs/current/serverless/elasticsearch/what-is-elasticsearch-serverless) -- [Dev tools](https://www.elastic.co/docs/current/serverless/devtools/developer-tools) -- [Project and management settings](https://www.elastic.co/docs/current/serverless/project-and-management-settings) - -> Not the docs you're looking for? Try the following: -> -> - For Elastic Observability, visit [elastic/observability-docs](https://github.com/elastic/observability-docs). -> - For Elastic Security, visit [elastic/security-docs](https://github.com/elastic/security-docs). -> - For all other documentation, click the **✏️ edit** button on any page to jump to its source in GitHub. - -## Reviews - -All documentation pull requests automatically add the [@platform-docs](https://github.com/orgs/elastic/teams/platform-docs) team as a reviewer. +This repo contains source files for Elastic documentation. ## Contribute -If you find any bugs in our documentation, or want to request an enhancement, then you can open an issue using our template. We also welcome contributions in the form of PRs. Before you submit a PR, make sure that you have signed our [Contributor License Agreement](https://www.elastic.co/contributor-agreement/). +If you find any bugs in our documentation, or want to request an enhancement, please [open an issue](https://github.com/elastic/docs-content/issues). We also welcome contributions in the form of PRs. Before you submit a PR, make sure that you have signed our [Contributor License Agreement](https://www.elastic.co/contributor-agreement/). -This documentation uses [AsciiDoc](https://github.com/elastic/docs?tab=readme-ov-file#asciidoc-guide). +We write our docs in markdown. See our [syntax guide](https://elastic.github.io/docs-builder/syntax/index.html) for examples and additional functionality. -## Preview the docs +### Preview your changes -When you open a PR, a preview is automatically generated. A link to the preview is added as a comment. +When you open a PR, your changes are built, deployed, and ready to be previewed within minutes. ## License -Shield: [![CC BY-NC-ND 4.0][cc-by-nc-nd-shield]][cc-by-nc-nd] +[![CC BY-NC-ND 4.0][cc-by-nc-nd-image]][cc-by-nc-nd] [![CC BY-NC-ND 4.0][cc-by-nc-nd-shield]][cc-by-nc-nd] This work is licensed under a [Creative Commons Attribution-NonCommercial-NoDerivs 4.0 International License][cc-by-nc-nd]. -[![CC BY-NC-ND 4.0][cc-by-nc-nd-image]][cc-by-nc-nd] - [cc-by-nc-nd]: http://creativecommons.org/licenses/by-nc-nd/4.0/ [cc-by-nc-nd-image]: https://licensebuttons.net/l/by-nc-nd/4.0/88x31.png -[cc-by-nc-nd-shield]: https://img.shields.io/badge/License-CC%20BY--NC--ND%204.0-lightgrey.svg \ No newline at end of file +[cc-by-nc-nd-shield]: https://img.shields.io/badge/License-CC%20BY--NC--ND%204.0-lightgrey.svg