Skip to content

Commit 59b76de

Browse files
authored
Merge branch 'main' into leemthompo/put-contribution-sections-at-bottom-of-nav
2 parents 795612a + 4a74752 commit 59b76de

File tree

21 files changed

+308
-174
lines changed

21 files changed

+308
-174
lines changed

.github/actions/bootstrap/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ runs:
3838
echo "full-version=${REPO_VERSION}" >> $GITHUB_OUTPUT
3939
echo "major-version=$(echo ${REPO_VERSION} | cut -d"." -f1)" >> $GITHUB_OUTPUT
4040
41-
- uses: actions/setup-node@v5
41+
- uses: actions/setup-node@v6
4242
with:
4343
cache: npm
4444
cache-dependency-path: src/Elastic.Documentation.Site/package-lock.json

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ jobs:
7777
steps:
7878
- uses: actions/checkout@v5
7979

80-
- uses: actions/setup-node@v5
80+
- uses: actions/setup-node@v6
8181
with:
8282
cache: npm
8383
cache-dependency-path: src/Elastic.Documentation.Site/package-lock.json

.github/workflows/preview-build.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,10 @@ jobs:
452452
&& (steps.docs-build.outputs.skip != 'true' || steps.internal-docs-build.outputs.skip != 'true')
453453
&& steps.deployment.outputs.result
454454
&& (steps.docs-build.outcome == 'success' || steps.internal-docs-build.outcome == 'success')
455+
env:
456+
# https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-retries.html#cli-usage-retries-configure
457+
AWS_RETRY_MODE: standard
458+
AWS_MAX_ATTEMPTS: 6
455459
run: |
456460
aws s3 sync .artifacts/docs/html "s3://elastic-docs-v3-website-preview${PATH_PREFIX}" --delete --no-follow-symlinks
457461
aws cloudfront create-invalidation \

config/navigation.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -573,10 +573,10 @@ toc:
573573
path_prefix: reference/ecs/logging/ruby
574574
# Children include the entire AsciiDoc book
575575

576-
# Data analysis
577-
# https://github.com/elastic/docs-content/blob/main/reference/data-analysis/toc.yml
578-
- toc: docs-content://reference/data-analysis
579-
path_prefix: reference/data-analysis
576+
# Machine learning (FKA Data analysis)
577+
# https://github.com/elastic/docs-content/blob/main/reference/machine-learning/toc.yml
578+
- toc: docs-content://reference/machine-learning
579+
path_prefix: reference/machine-learning
580580

581581
# Search UI
582582
# https://github.com/elastic/search-ui/blob/main/docs/reference/toc.yml

config/versions.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ versioning_systems:
5050
current: 1.55.1
5151
apm-agent-node:
5252
base: 4.0
53-
current: 4.14.0
53+
current: 4.15.0
5454
apm-agent-php:
5555
base: 1.0
5656
current: 1.15.1

docs/cli/assembler/assembler-index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ docs-builder assembler index [options...] [-h|--help] [--version]
4444
`--index-name-prefix` `<string>`
4545
: The prefix for the computed index/alias names. Defaults: semantic-docs (optional)
4646

47+
`--force-reindex` `<bool?>`
48+
: Force reindex strategy to semantic index, by default, we multiplex writes if the semantic index does not exist yet (optional)
49+
4750
`--buffer-size` `<int?>`
4851
: The number of documents to send to ES as part of the bulk. Defaults: 100 (optional)
4952

docs/cli/docset/index-command.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ docs-builder index [options...] [-h|--help] [--version]
4040
`--index-name-prefix` `<string>`
4141
: The prefix for the computed index/alias names. Defaults: semantic-docs (optional)
4242

43+
`--force-reindex` `<bool?>`
44+
: Force reindex strategy to semantic index, by default, we multiplex writes if the semantic index does not exist yet (optional)
45+
4346
`--buffer-size` `<int?>`
4447
: The number of documents to send to ES as part of the bulk. Defaults: 100 (optional)
4548

docs/syntax/frontmatter.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,16 @@ applies_to: <3>
1515
products: <4>
1616
- id: apm-agent
1717
- id: edot-sdk
18+
sub: <5>
19+
key: value
1820
---
1921
```
2022

2123
1. [`navigation_title`](#navigation-title)
2224
2. [`description`](#description)
2325
3. [`applies_to`](#applies-to)
2426
4. [`products`](#products)
27+
5. [`sub`](#subs)
2528

2629
## Navigation Title
2730

@@ -83,3 +86,7 @@ The products frontmatter is a list of objects, each object has an `id` field.
8386
| `search-ui` | Search UI |
8487
| `security` | Elastic Security |
8588
| `winlogbeat` | Winlogbeat |
89+
90+
## Subs
91+
92+
Use the `sub` field to define local substitutions. Refer to [Substitutions](substitutions.md) for more information.

docs/syntax/images.md

Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ If a page uses an image that exists outside the folder that contains the `toc.ym
1919

2020
![APM](/syntax/images/apm.png)
2121

22-
2322
Or, use the `image` directive.
2423

2524
```markdown
@@ -34,12 +33,41 @@ Or, use the `image` directive.
3433
:width: 250px
3534
:::
3635

36+
### Image centering
37+
38+
Images that are not full width are automatically centered within their container. This is particularly useful when you specify a width constraint:
39+
40+
```markdown
41+
:::{image} /syntax/images/apm.png
42+
:alt: APM Logo
43+
:width: 400px
44+
:::
45+
```
46+
47+
:::{image} /syntax/images/apm.png
48+
:alt: APM Logo
49+
:width: 400px
50+
:::
51+
52+
The image above is centered because it has a width of 400px, which is less than the full container width.
53+
54+
Note that images nested within other content (like lists or admonitions) are not centered:
55+
56+
- First item in the list
57+
- Second item with an image:
58+
59+
:::{image} /syntax/images/apm.png
60+
:alt: APM Logo in list
61+
:width: 400px
62+
:::
63+
64+
- Third item in the list
65+
3766
## Screenshots
3867

3968
Screenshots are images displayed with a box-shadow. Define a screenshot by adding the `:screenshot:` attribute to a block-level image directive.
4069

4170
```markdown
42-
4371
:::{image} /syntax/images/apm.png
4472
:screenshot:
4573
:::
@@ -57,7 +85,6 @@ Here is the same image used inline ![Elasticsearch](/syntax/images/observability
5785

5886
Here is the same image used inline ![Elasticsearch](/syntax/images/observability.png "elasticsearch =50%x50%")
5987

60-
6188
### Inline image titles
6289

6390
Titles are optional making this the minimal syntax required:
@@ -74,7 +101,6 @@ For inline images, the alt text always overrides any title specified in the Mark
74101

75102
![Elasticsearch](/syntax/images/observability.png "Different title =50%x50%")
76103

77-
78104
### Inline image sizing
79105

80106
Image sizing is specified through the title argument. You can specify just the size without needing to provide a redundant title:
@@ -99,24 +125,24 @@ If `H` is omitted `W` is used as the height as well.
99125
When specifying just the size without a title, no space is required before the `=` sign. When combining a title with sizing, a space is required before the `=`:
100126

101127
```markdown
102-
![alt](img.png "=50%") <!-- Just size, no space needed -->
103-
![alt](img.png "My Title =50%") <!-- With title, space required -->
128+
![alt](img.png "=50%") <!-- Just size, no space needed -->
129+
![alt](img.png "My Title =50%") <!-- With title, space required -->
104130
```
105131

106-
107-
108-
### SVG
132+
### SVG
109133

110134
```markdown
111135
![Elasticsearch](/syntax/images/alerts.svg)
112136
```
137+
113138
![Elasticsearch](/syntax/images/alerts.svg)
114139

115140
### GIF
116141

117142
```markdown
118143
![Elasticsearch](/syntax/images/timeslider.gif)
119144
```
145+
120146
![Elasticsearch](/syntax/images/timeslider.gif)
121147

122148
## Asciidoc syntax
@@ -147,11 +173,14 @@ The image carousel directive builds upon the image directive.
147173

148174
:::{image} images/applies.png
149175
:alt: Second image description
176+
150177
### Title is optional - alt text will be used as title if not specified
178+
151179
:::
152180

153181
::::
154182
```
183+
155184
::::{carousel}
156185

157186
:id: nested-carousel-example

docs/syntax/substitutions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ In both cases the yaml to define them is as followed:
1818

1919

2020
```yaml
21-
subs:
21+
sub:
2222
key: value
2323
another-var: Another Value
2424
```
@@ -222,7 +222,7 @@ Regular inline code (without the `{subs}` role) will not process substitutions a
222222

223223
## Products
224224

225-
Product substitutions use `products.yml` to determine what will be displayed. Use the product's key to get its display name.
225+
Product substitutions use [`products.yml`](https://github.com/elastic/docs-builder/blob/main/config/products.yml) to determine what will be displayed. Use the product's key to get its display name.
226226

227227
```yaml
228228
# products.yml

0 commit comments

Comments
 (0)