You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,13 @@ This repository is host to:
12
12
Both get distributed [as native OSX, Linux and Windows binaries for several CPU architectures.](#installation)
13
13
14
14
The documentation files:
15
-
* are written in common Markdown with [Additional syntax extension](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/syntax/) to produce a richer writing and reading experience.
15
+
* are written in common Markdown with [Additional syntax extensions](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/syntax/) to produce a richer writing and reading experience.
16
16
* By conventions the documentation lives in `docs` folder but the tooling will look for any folder holding a `docset.yml` file given the current working directory.
17
17
18
18
## Distributed documentation
19
19
20
20
The main driver for folks writing documentation is `docs-builder`.
21
-
This tool builds each repository in isolation and in addition produces a links.json file.
21
+
This tool builds each repository in isolation and in addition produces a full mapping of all the linkable resources it contains in a `links.json` file.
22
22
23
23
Each time a repository successfully builds on its respective main integration branch, our automation will publish its links.json file.
24
24
For example, [Elasticsearch's links.json](https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/elasticsearch/main/links.json) representing all linkable resources in the Elasticsearch repository.
@@ -32,7 +32,6 @@ This allows us to:
32
32
* Documentation errors in one repository won't affect all the others.
33
33
* Resilient to repositories having build failures on their integration branches, we fall back to the last known good commit.
0 commit comments