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
+11-16Lines changed: 11 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,19 +11,24 @@ This repository is host to:
11
11
12
12
Both get distributed [as native OSX, Linux and Windows binaries for several CPU architectures.](#installation)
13
13
14
+
The documentation files:
15
+
* are written in common Markdown
16
+
*[Additional syntax extension](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/syntax/) are supported to produce a richer writing and reading experience.
17
+
* 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.
18
+
14
19
## Distributed documentation
15
20
16
21
The main driver for folks writing documentation is `docs-builder`.
17
22
This tool builds each repository in isolation and in addition produces a links.json file.
18
23
19
-
Each time a repository successfully builds on its respective main integration branch, the tool will update its links.json file.
20
-
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.
24
+
Each time a repository successfully builds on its respective main integration branch, our automation will publish its links.json file.
25
+
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.
21
26
22
27
The `docs-assembler` tool then assembles all the repositories in the [link-registry](https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/link-index.json) using their last known good commit.
23
28
24
29
This allows us to:
25
30
26
-
* Validate outbound and inbound links ahead of timeduring `docs-builder` builds.
31
+
* Validate outbound and inbound links ahead of time, even during local`docs-builder` builds.
27
32
* Snapshot builds: only building commits that produced a `links.json`
28
33
* Documentation errors in one repository won't affect all the others.
29
34
* Resilient to repositories having build failures on their integration branches, we fall back to the last known good commit.
@@ -71,10 +76,10 @@ The TLDR, however, is
71
76
* You can leave this command running while you add/remove/rename files in your `docs` folder.
72
77
73
78
79
+
### Other commands to know:
74
80
75
-
#### Live mode
76
-
77
-
Through the `serve` command you can continuously and partially compile your documentation.
81
+
*`docs-builder mv`[Move files and folders](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/move)
82
+
*`docs-builder diff validate`[Manage redirects across doc sets](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/redirects#validation)
If documentation is moved, renamed or deleted, `docs-builder` can verify if changes in the working branch in relation to the default branch are reflected in the repository's `redirects.yml`. Verification in the local machine is currently supported.
127
-
128
-
`docs-builder diff validate <path>`
129
-
130
-
`<path>`is an optional parameter to customize the documentation folder path. It defaults to `docs`.
131
-
132
-
---
133
-
134
129
# Local Development
135
130
136
131
See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to develop locally and contribute to the project.
0 commit comments