Skip to content

Commit 109645f

Browse files
authored
Update README.md (#282)
1 parent deab706 commit 109645f

File tree

1 file changed

+8
-25
lines changed

1 file changed

+8
-25
lines changed

README.md

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,24 @@
1-
# docs-content
1+
# Elastic Docs Content
22

3-
This repo contains most of our Elastic Serverless documentation, including:
4-
5-
- [Overview content](https://www.elastic.co/docs/current/serverless)
6-
- [Elasticsearch](https://www.elastic.co/docs/current/serverless/elasticsearch/what-is-elasticsearch-serverless)
7-
- [Dev tools](https://www.elastic.co/docs/current/serverless/devtools/developer-tools)
8-
- [Project and management settings](https://www.elastic.co/docs/current/serverless/project-and-management-settings)
9-
10-
> Not the docs you're looking for? Try the following:
11-
>
12-
> - For Elastic Observability, visit [elastic/observability-docs](https://github.com/elastic/observability-docs).
13-
> - For Elastic Security, visit [elastic/security-docs](https://github.com/elastic/security-docs).
14-
> - For all other documentation, click the **✏️ edit** button on any page to jump to its source in GitHub.
15-
16-
## Reviews
17-
18-
All documentation pull requests automatically add the [@platform-docs](https://github.com/orgs/elastic/teams/platform-docs) team as a reviewer.
3+
This repo contains source files for Elastic documentation.
194

205
## Contribute
216

22-
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/).
7+
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/).
238

24-
This documentation uses [AsciiDoc](https://github.com/elastic/docs?tab=readme-ov-file#asciidoc-guide).
9+
We write our docs in markdown. See our [syntax guide](https://elastic.github.io/docs-builder/syntax/index.html) for examples and additional functionality.
2510

26-
## Preview the docs
11+
### Preview your changes
2712

28-
When you open a PR, a preview is automatically generated. A link to the preview is added as a comment.
13+
When you open a PR, your changes are built, deployed, and ready to be previewed within minutes.
2914

3015
## License
3116

32-
Shield: [![CC BY-NC-ND 4.0][cc-by-nc-nd-shield]][cc-by-nc-nd]
17+
[![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]
3318

3419
This work is licensed under a
3520
[Creative Commons Attribution-NonCommercial-NoDerivs 4.0 International License][cc-by-nc-nd].
3621

37-
[![CC BY-NC-ND 4.0][cc-by-nc-nd-image]][cc-by-nc-nd]
38-
3922
[cc-by-nc-nd]: http://creativecommons.org/licenses/by-nc-nd/4.0/
4023
[cc-by-nc-nd-image]: https://licensebuttons.net/l/by-nc-nd/4.0/88x31.png
41-
[cc-by-nc-nd-shield]: https://img.shields.io/badge/License-CC%20BY--NC--ND%204.0-lightgrey.svg
24+
[cc-by-nc-nd-shield]: https://img.shields.io/badge/License-CC%20BY--NC--ND%204.0-lightgrey.svg

0 commit comments

Comments
 (0)