Skip to content

Commit e413e32

Browse files
committed
Merge remote-tracking branch 'origin/main' into feature/api-docs-multiple
2 parents b6e0172 + 408c009 commit e413e32

File tree

105 files changed

+4167
-568
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+4167
-568
lines changed

src/tooling/docs-assembler/assembler.yml renamed to config/assembler.yml

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,26 @@ environments:
2020
edge:
2121
uri: https://d34ipnu52o64md.cloudfront.net
2222
path_prefix: docs
23-
content_source: current
23+
content_source: edge
2424
google_tag_manager:
2525
enabled: false
2626
feature_flags:
2727
LAZY_LOAD_NAVIGATION: true
2828
dev:
2929
uri: http://localhost:4000
30-
content_source: next
30+
content_source: current
3131
path_prefix: docs
3232

33-
named_git_references:
34-
stack: &stack 9.0
35-
cloud-hosted: ms-120
33+
shared_configuration:
34+
stack: &stack
35+
current: 9.0
36+
next: 9.1
37+
edge: main
38+
39+
master: &master
40+
current: master
41+
next: master
42+
edge: master
3643

3744
###
3845
# 'narrative' shares the same keys as keys in 'references' (<repository_config>)
@@ -67,9 +74,6 @@ references:
6774
apm-agent-rum-js:
6875
apm-aws-lambda:
6976
apm-k8s-attacher:
70-
beats:
71-
current: "9.0"
72-
next: main
7377
ecs-dotnet:
7478
ecs-logging-go-logrus:
7579
ecs-logging-go-zap:
@@ -80,9 +84,6 @@ references:
8084
ecs-logging-python:
8185
ecs-logging-ruby:
8286
ecs-logging:
83-
ecs:
84-
current: "9.0"
85-
next: main
8687
elastic-otel-dotnet:
8788
elastic-otel-java:
8889
elastic-otel-node:
@@ -92,22 +93,20 @@ references:
9293
integration-docs:
9394
integrations:
9495
logstash-docs-md:
95-
logstash:
96-
current: "9.0"
97-
next: main
9896
opentelemetry:
99-
97+
98+
#stack aligned using gated deploys
99+
beats: *stack
100+
logstash: *stack
101+
ecs:
102+
<<: *stack
103+
next: main
104+
100105
# @elastic/admin-docs
101106
cloud-on-k8s:
102-
cloud:
103-
current: master
104-
next: master
105-
curator:
106-
current: master
107-
next: master
108-
ecctl:
109-
current: master
110-
next: master
107+
cloud: *master
108+
curator: *master
109+
ecctl: *master
111110

112111
# @elastic/admin-docs and @elastic/developer-docs
113112
elasticsearch:
File renamed without changes.

src/Elastic.Documentation.Configuration/versions.yml renamed to config/versions.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
versioning_systems:
22
stack: &stack
33
base: 9.0
4-
current: 9.0
4+
current: 9.0.3
55

66
# Using an unlikely high version
77
# So that our logic that would display "planned" doesn't trigger
@@ -91,4 +91,4 @@ versioning_systems:
9191
edot_cf_aws:
9292
base: 0.1
9393
current: 0.1.6
94-
94+

docs-builder.sln

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,14 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.Documentation.Legac
111111
EndProject
112112
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.Documentation.LegacyDocs.Tests", "tests\Elastic.Documentation.LegacyDocs.Tests\Elastic.Documentation.LegacyDocs.Tests.csproj", "{164F55EC-9412-4CD4-81AD-3598B57632A6}"
113113
EndProject
114+
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "config", "config", "{6FAB566B-76E3-4E90-8A5C-E75B0F1E1C63}"
115+
ProjectSection(SolutionItems) = preProject
116+
config\versions.yml = config\versions.yml
117+
config\assembler.yml = config\assembler.yml
118+
config\legacy-url-mappings.yml = config\legacy-url-mappings.yml
119+
config\navigation.yml = config\navigation.yml
120+
EndProjectSection
121+
EndProject
114122
Global
115123
GlobalSection(SolutionConfigurationPlatforms) = preSolution
116124
Debug|Any CPU = Debug|Any CPU

docs/_docset.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,13 +94,15 @@ toc:
9494
- file: frontmatter.md
9595
- file: icons.md
9696
- file: images.md
97+
- file: kbd.md
9798
- file: lists.md
9899
- file: line_breaks.md
99100
- file: links.md
100101
- file: passthrough.md
101102
- file: sidebars.md
102103
- file: stepper.md
103104
- file: substitutions.md
105+
- file: version-variables.md
104106
- file: sundries.md
105107
- file: tables.md
106108
- file: tabs.md
@@ -123,6 +125,10 @@ toc:
123125
- file: custom-highlighters.md
124126
- hidden: archive.md
125127
- hidden: landing-page.md
128+
- file: nest-under-index/index.md
129+
children:
130+
- file: nest-under-index/nested-page-1.md
131+
- file: nest-under-index/nested-page-2.md
126132
- folder: mover
127133
children:
128134
- file: first-page.md

docs/configure/content-sources.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Tagged
3535

3636
This is the default. To get started, follow our [guide](/migration/guide/index.md) to set up the new docs folder structure and CI configuration.
3737

38-
Once setup ensure the repository is added to our `assembler.yml` under `references`.
38+
Once setup ensure the repository is added to our [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/config/assembler.yml) under `references`.
3939

4040
For example say you want to onboard `elastic/my-repository` into the production build:
4141

@@ -59,7 +59,7 @@ Once the repository is added, its navigation still needs to be injected into to
5959
### Tagged
6060
6161
If you want to have more control over the timing of when your docs go live to production. Configure the repository
62-
in our `assembler.yml` to have a fixed git reference (typically a branch) deploy the `current` content source to production.
62+
in our [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/config/assembler.yml) to have a fixed git reference (typically a branch) deploy the `current` content source to production.
6363

6464
```yaml
6565
references:
@@ -101,4 +101,4 @@ jobs:
101101
pull-requests: write
102102
```
103103

104-
1. Ensure version branches are built and publish their links ahead of time.
104+
1. Ensure version branches are built and publish their links ahead of time.

docs/configure/site/content.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# `assembler.yml`
22

3-
The global navigation is defined in the `assembler.yml` file. This file can roughly be thought of as the V3 equivalent of conf.yaml in the asciidoc build system. This file, which writers own, allows for arbitrary nesting of `docset.yml` and `toc.yml` references. This file will live in the `elastic/docs-content` repository, but will not build or have any influence over the `docs-builder` builds in that repo.
3+
The global navigation is defined in the [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/config/assembler.yml) file. This file can roughly be thought of as the V3 equivalent of conf.yaml in the asciidoc build system. This file, which writers own, allows for arbitrary nesting of `docset.yml` and `toc.yml` references. This file will live in the `elastic/docs-content` repository, but will not build or have any influence over the `docs-builder` builds in that repo.
44

5-
The global navigation that is defined in `assembler.yml` can be composed of three main resources:
5+
The global navigation that is defined in [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/config/assembler.yml) can be composed of three main resources:
66
1. Local TOC files: toc.yml files that live in the docs-content repository.
77
2. External TOC files: A subset of a content set (represented by a toc.yml file) that is external to the docs-content repository.
88
3. External content set declarations: An entire docset.yml file that is external to the docs-content repository.
99

10-
The `assembler.yml` file might look something like this:
10+
The [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/config/assembler.yml) file might look something like this:
1111

1212
```yaml
1313

docs/configure/site/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ TBD
2222
In both the AsciiDoctor- and V3-based system, there is site-wide configuration where you list all content sources, where to find those sources, and in what order they should be added to the site.
2323

2424
In the AsciiDoctor system, this all happens in one YAML file in the `/docs` repo. In the V3 system:
25-
* Content configuration happens in the [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/src/tooling/docs-assembler/assembler.yml) file in `docs-builder`.
26-
* Navigation configuration happens in the [`navigation.yml`](https://github.com/elastic/docs-builder/blob/main/src/tooling/docs-assembler/navigation.yml) file in `docs-builder`.
25+
* Content configuration happens in the [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/config/assembler.yml) file in `docs-builder`.
26+
* Navigation configuration happens in the [`navigation.yml`](https://github.com/elastic/docs-builder/blob/main/config/navigation.yml) file in `docs-builder`.
2727

2828
[assembler.yml](./content.md)
2929

docs/contribute/_snippets/tag-processing.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@ Specifically for versioned products, badges will display differently when the `a
1212

1313
Example: {applies_to}`stack: removed 99.99`
1414

15-
This is computed at build time (there is a docs build every 30 minutes). The documentation team tracks and maintains released versions for these products centrally in [versions.yml](https://github.com/elastic/docs-builder/blob/main/src/Elastic.Documentation.Configuration/versions.yml).
16-
15+
This is computed at build time (there is a docs build every 30 minutes). The documentation team tracks and maintains released versions for these products centrally in [`versions.yml`](https://github.com/elastic/docs-builder/blob/main/config/versions.yml).
1716
When multiple lifecycle statuses and versions are specified in the sources, several badges are shown.
1817

1918
:::{note}
2019
Visuals and wording in the output documentation are subject to changes and optimizations.
21-
:::
20+
:::

0 commit comments

Comments
 (0)