Skip to content

Commit ed9aeb1

Browse files
committed
Add documentation
1 parent 1ddfa3e commit ed9aeb1

File tree

5 files changed

+58
-8
lines changed

5 files changed

+58
-8
lines changed

docs/_docset.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ toc:
7676
- file: navigation.md
7777
- file: versions.md
7878
- file: legacy-url-mappings.md
79+
- file: products.md
7980
- folder: content-set
8081
children:
8182
- file: index.md

docs/configure/site/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Configure the documentation site in these files:
1010
- [](./navigation.md) - global navigation index
1111
- [](./versions.md) - global versioning schemes
1212
- [](./legacy-url-mappings.md) - supported legacy version
13+
- [](./products.md) - company product metadata
1314

1415
## Redirects
1516

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

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ This [`legacy-url-mappings.yml`](https://github.com/elastic/docs-builder/blob/ma
55
This example maps documentation that references `elastic.co/guide/en/elasticsearch/reference/ to Elastic Stack versioned URL paths:
66

77
```yml
8-
en/elasticsearch/reference/: *stack
8+
en/elasticsearch/reference/:
9+
product: elastic-stack
10+
legacy_versions: *stack
911
```
1012
1113
## Structure
@@ -14,11 +16,7 @@ en/elasticsearch/reference/: *stack
1416
: Defines a reusable list of version strings for "stack" projects, e.g., [ '9.0+', '8.18', ... ].
1517

1618
`mappings`
17-
: A YAML mapping where each key is a legacy documentation URL path (like `en/apm/agent/java/`) and the value is a list of asciidoc versions that exist for that path.
18-
19-
:::{important}
20-
The first version in the `mappings` list is treated as the "current" version in documentation version dropdown.
21-
:::
22-
23-
## Example entry
19+
: A YAML mapping where each key is a legacy documentation URL path (like `en/apm/agent/java/`), and each value is a mapping with:
20+
* `product`: Specifies the product or project type (e.g., `elastic-stack`, `eck`, `ece`, `self-managed`, etc.). Products must be defined in [`products.yml`](https://github.com/elastic/docs-builder/blob/main/config/products.yml). See [products.yml](./products.md) for more information.
21+
* `legacy_versions`: A list of version strings that correspond to the available asciidoc pages.
2422

docs/configure/site/products.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# `products.yml`
2+
3+
The [`products.yml`](https://github.com/elastic/docs-builder/blob/main/config/products.yml) file specifies metadata regarding the projects in the organization leveraging v3.
4+
5+
```yml
6+
products:
7+
apm-agent-dotnet:
8+
display: 'APM Agent for .NET'
9+
versioning: 'apm_agent_dotnet'
10+
edot-collector:
11+
display: 'Elastic Distribution of OpenTelemetry Collector'
12+
versioning: 'stack'
13+
#...
14+
```
15+
16+
## Structure
17+
18+
`products`
19+
: A YAML mapping where each key is an Elastic product.
20+
* `display`: A friendly name for the product.
21+
* `versioning`: The versioning system used by the project. The value for this field must match one of the versioning systems defined in [`versions.yml`](https://github.com/elastic/docs-builder/blob/main/config/versions.yml)
22+
23+
24+
25+
## Substitutions
26+
27+
The following substitutions are available:
28+
29+
| Substitution | Result |
30+
| --- |---|
31+
| `{{ product.apm-agent-dotnet }}` |{{ product.apm-agent-dotnet }} |
32+
| `{{ .apm-agent-ios }}` | {{ .apm-agent-ios }} |
33+
34+
## See also
35+
36+
[](./versions.md)
37+
[](./legacy-url-mappings.md)

docs/syntax/version-variables.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ This is dictated by the [`versions.yml`](https://github.com/elastic/docs-builder
8282
* `ech`
8383
* `eck`
8484
* `ess`
85+
* `esf`
86+
* `search_ui`
8587
* `self`
8688
* `ecctl`
8789
* `curator`
@@ -105,6 +107,17 @@ This is dictated by the [`versions.yml`](https://github.com/elastic/docs-builder
105107
* `edot_python`
106108
* `edot_cf_aws`
107109
* `edot_collector`
110+
* `apm_attacher`
111+
* `apm_lambda`
112+
* `ecs_logging_dotnet`
113+
* `ecs_logging_go_logrus`
114+
* `ecs_logging_go_zap`
115+
* `ecs_logging_go_zerolog`
116+
* `ecs_logging_java`
117+
* `ecs_logging_nodejs`
118+
* `ecs_logging_php`
119+
* `ecs_logging_python`
120+
* `ecs_logging_ruby`
108121

109122
The following are available but should not be used. These map to serverless projects and have a fixed high version number.
110123

0 commit comments

Comments
 (0)