Skip to content

Commit cc0c479

Browse files
committed
touchups
1 parent e6eb8bc commit cc0c479

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ This repository is host to:
1212
Both get distributed [as native OSX, Linux and Windows binaries for several CPU architectures.](#installation)
1313

1414
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.
1616
* 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.
1717

1818
## Distributed documentation
1919

2020
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.
2222

2323
Each time a repository successfully builds on its respective main integration branch, our automation will publish its links.json file.
2424
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:
3232
* Documentation errors in one repository won't affect all the others.
3333
* Resilient to repositories having build failures on their integration branches, we fall back to the last known good commit.
3434

35-
3635
## Installation
3736

3837
### Linux / OSX

0 commit comments

Comments
 (0)