Skip to content

Commit afd6741

Browse files
authored
Update README.md (#2230)
* 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
1 parent e7d4416 commit afd6741

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
1-
#docs-builder
1+
# docs-builder
22

33
[![ci](https://github.com/elastic/docs-builder/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/elastic/docs-builder/actions/workflows/ci.yml)
44

55
Distributed documentation tooling for a distributed company.
66

77
* *`docs-builder`* command line tool to generate single doc-sets
88

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)
1010

1111
The documentation files:
1212
* 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.
1313
* 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.
1414

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+
1519
## Distributed documentation
1620

1721
The main driver for folks writing documentation is `docs-builder`.
22+
1823
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.
1924

2025
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
4752

4853
### Building locally
4954

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:
5156

5257
```bash
5358
./build.sh publishbinaries
@@ -56,11 +61,11 @@ After which the locally built binaries will be available at:
5661

5762
* **docs-builder**: `./.artifacts/publish/docs-builder/release/docs-builder`
5863

59-
## Getting Started
64+
## Getting started
6065

61-
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.
6267

63-
The TLDR, however, is
68+
The essential commands are:
6469

6570
* Running `docs-builder` from the root of any checkout with a `docs` folder will build the documentation.
6671
* Running `docs-builder` consecutively will only rebuild the documentation that has changed.
@@ -69,13 +74,13 @@ The TLDR, however, is
6974
* Running `docs-builder serve` will provide a local server with live reloading.
7075
* You can leave this command running while you add/remove/rename files in your `docs` folder.
7176

72-
7377
### Other commands to know:
7478

7579
* `docs-builder mv` [Move files and folders](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/move)
7680
* `docs-builder diff validate` [Manage redirects across doc sets](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/redirects#validation)
7781
* `docs-builder inbound-links validate-link-reference` can be used after a build to validate the local `links.json` against all published documentation.
7882

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).
7984

8085
## Github Action
8186

@@ -141,6 +146,6 @@ https://github.com/elastic/{your-repository}/settings/pages
141146
142147
---
143148
144-
# Local Development
149+
# Local development
145150
146-
See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to develop locally and contribute to the project.
151+
Refer to [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to develop locally and contribute to the project.

0 commit comments

Comments
 (0)