Skip to content

Commit 7aeacfe

Browse files
committed
touchups
1 parent e7d5b4f commit 7aeacfe

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
@@ -13,7 +13,7 @@ Both get distributed [as native OSX, Linux and Windows binaries for several CPU
1313

1414
The documentation files:
1515
* 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-
* 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.
16+
* 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.
1717

1818
## Distributed documentation
1919

@@ -78,6 +78,7 @@ The TLDR, however, is
7878

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

8283

8384
## Github Action
@@ -96,8 +97,6 @@ jobs:
9697
uses: elastic/docs-builder@main
9798
```
9899
99-
100-
101100
### GitHub Pages
102101
103102
To set up the tool to publish to GitHub Pages, use the following configuration.

0 commit comments

Comments
 (0)