Skip to content

Commit 61ac8bb

Browse files
committed
a little more
Signed-off-by: bmorelli25 <[email protected]>
1 parent 45c254c commit 61ac8bb

File tree

4 files changed

+67
-7
lines changed

4 files changed

+67
-7
lines changed

docs/configure/site/content.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,55 @@ This section defines different build environments for the documentation site.
1717

1818
Each environment specifies configuration details such as the site URI, content source, path prefix, Google Tag Manager settings, and feature flags.
1919

20+
Example:
21+
22+
```yml
23+
environments:
24+
prod:
25+
uri: https://www.elastic.co
26+
path_prefix: docs
27+
content_source: current
28+
allow_indexing: true
29+
google_tag_manager:
30+
enabled: true
31+
id: GTM-KNJMG2M
32+
```
33+
2034
## `shared_configuration`
2135

22-
This section defines YAML anchors for common settings shared among multiple repositories.
36+
This section defines YAML anchors for common settings shared among multiple repositories and deployment environments.
37+
38+
The following example sets a unique `stack` version for each of the three defined deployment environments:
39+
40+
```yml
41+
stack: &stack
42+
current: 9.0
43+
next: 9.1
44+
edge: main
45+
```
2346

2447
## `narrative`
2548

2649
Configures the main `docs-content` repository.
2750

51+
Example:
52+
53+
```yml
54+
narrative:
55+
checkout_strategy: full
56+
```
57+
2858
## `references`
2959

3060
Configures all other repositories whose docs content should be included or referenced in the build. Each can have custom settings for branch, checkout method, etc.
3161

62+
Example:
63+
64+
```yml
65+
references:
66+
apm-server:
67+
```
68+
3269
### Branching strategy
3370

3471
How you add a reference repository depends on its [branching strategy](../content-sources.md#branching-strategies).

docs/configure/site/legacy-url-mappings.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# Legacy URL mappings
22

3-
This [`legacy-url-mappings.yml`](https://github.com/elastic/docs-builder/blob/main/config/legacy-url-mappings.yml) file manages legacy URL patterns for Elastic documentation, mapping the path of each legacy build URL to a list of documentation versions.
3+
This [`legacy-url-mappings.yml`](https://github.com/elastic/docs-builder/blob/main/config/legacy-url-mappings.yml) file manages legacy URL patterns for Elastic documentation, mapping the path of each legacy build URL to a list of documentation versions. It ensures that users can easily find previous versions of our documentation.
44

5-
It ensures that users can easily find previous versions of our documentation.
5+
This example maps documentation that references `elastic.co/guide/en/elasticsearch/reference/ to Elastic Stack versioned URL paths:
6+
7+
```yml
8+
en/elasticsearch/reference/: *stack
9+
```
610
711
## Structure
812
@@ -18,6 +22,3 @@ The first version in the `mappings` list is treated as the "current" version in
1822

1923
## Example entry
2024

21-
```yml
22-
en/elasticsearch/reference/: *stack
23-
```

docs/configure/site/navigation.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
The [`navigation.yml`](https://github.com/elastic/docs-builder/blob/main/config/navigation.yml) file acts as a global navigation index. Each entry points to a `toc.yml` file, which contains the navigation tree for that section. This design allows each section/project/team to manage its own navigation independently of other content sets.
44

5+
Example:
6+
7+
```yml
8+
toc:
9+
- toc: get-started # No toc.yml indicates a docs-content directory
10+
- toc: extend
11+
children:
12+
- toc: kibana://extend # A toc.yml file in the Kibana repo at docs/extend
13+
path_prefix: extend/kibana # The URL path for built content will be elastic.co/docs/extend/kibana/FILE_PATH+NAME
14+
```
15+
516
## `toc`
617

718
The location of the table of contents file.

docs/configure/site/versions.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
# `versions.yml`
22

3-
The [`versions.yml`](https://github.com/elastic/docs-builder/blob/main/config/versions.yml) file specifies which versions of each product should be recognized as the minimum (base) and the latest (current) in documentation builds. These versions are surfaced to the user via `applies_to` tags.
3+
The [`versions.yml`](https://github.com/elastic/docs-builder/blob/main/config/versions.yml) file specifies which versions of each product should be recognized as the minimum (base) and the latest (current) in documentation builds.
4+
5+
This example sets the Elastic Stack base and current versions while also assigning them to a variable that can be accessed with `*stack`
6+
7+
```yml
8+
versioning_systems:
9+
stack: &stack
10+
base: 9.0
11+
current: 9.0.4
12+
```
13+
14+
Versions set in this file are surfaced to the user via `applies_to` tags.
415

516
:::{include} /contribute/_snippets/tag-processing.md
617
:::

0 commit comments

Comments
 (0)