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
* Update README.md
Add links to new contribution docs and edit for style and accuracy. There was also a broken H1 heading.
* Add .NET line and link to CLI docs
Distributed documentation tooling for a distributed company.
6
6
7
7
**`docs-builder`* command line tool to generate single doc-sets
8
8
9
-
Distributed [as native OSX, Linux and Windows binaries for several CPU architectures.](#installation)
9
+
Distributed [as native macOS, Linux, and Windows binaries for several CPU architectures.](#installation)
10
10
11
11
The documentation files:
12
12
* 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.
13
13
* By conventions the documentation lives in `docs` folder but the tooling will look for any folder holding the `docset.yml` configuration file given the current working directory.
14
14
15
+
> [!TIP]
16
+
> To learn how to use docs-builder to contribute docs to Elastic, refer to [Contribute to the docs locally](https://www.elastic.co/docs/contribute-docs/locally
17
+
).
18
+
15
19
## Distributed documentation
16
20
17
21
The main driver for folks writing documentation is `docs-builder`.
22
+
18
23
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.
19
24
20
25
Each time a repository successfully builds on its respective main integration branch, our automation will publish its links.json file.
@@ -47,7 +52,7 @@ If you want to manually install the tool you can download the latest release fro
47
52
48
53
### Building locally
49
54
50
-
Install [.NET 9.0](https://dotnet.microsoft.com/en-us/download/dotnet/9.0), then run:
55
+
Install [.NET 10.0](https://dotnet.microsoft.com/en-us/download/dotnet/10.0), then run:
51
56
52
57
```bash
53
58
./build.sh publishbinaries
@@ -56,11 +61,11 @@ After which the locally built binaries will be available at:
Our [Documentation](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/locally) is the best place to learn how to start using the tool locally.
66
+
Our [Documentation](https://www.elastic.co/docs/contribute-docs/locally) is the best place to learn how to start using the tool locally.
62
67
63
-
The TLDR, however, is
68
+
The essential commands are:
64
69
65
70
* Running `docs-builder` from the root of any checkout with a `docs` folder will build the documentation.
66
71
* Running `docs-builder` consecutively will only rebuild the documentation that has changed.
@@ -69,13 +74,13 @@ The TLDR, however, is
69
74
* Running `docs-builder serve` will provide a local server with live reloading.
70
75
* You can leave this command running while you add/remove/rename files in your `docs` folder.
71
76
72
-
73
77
### Other commands to know:
74
78
75
79
*`docs-builder mv`[Move files and folders](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/move)
76
80
*`docs-builder diff validate`[Manage redirects across doc sets](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/redirects#validation)
77
81
*`docs-builder inbound-links validate-link-reference` can be used after a build to validate the local `links.json` against all published documentation.
78
82
83
+
For a complete reference of all available commands, refer to the [CLI documentation](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/cli).
0 commit comments