You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configure/content-sources.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,7 +35,7 @@ Tagged
35
35
36
36
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.
37
37
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`.
39
39
40
40
For example say you want to onboard `elastic/my-repository` into the production build:
41
41
@@ -59,7 +59,7 @@ Once the repository is added, its navigation still needs to be injected into to
59
59
### Tagged
60
60
61
61
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.
63
63
64
64
```yaml
65
65
references:
@@ -101,4 +101,4 @@ jobs:
101
101
pull-requests: write
102
102
```
103
103
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.
Copy file name to clipboardExpand all lines: docs/configure/site/content.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
# `assembler.yml`
2
2
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.
4
4
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:
6
6
1. Local TOC files: toc.yml files that live in the docs-content repository.
7
7
2. External TOC files: A subset of a content set (represented by a toc.yml file) that is external to the docs-content repository.
8
8
3. External content set declarations: An entire docset.yml file that is external to the docs-content repository.
9
9
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:
Copy file name to clipboardExpand all lines: docs/configure/site/index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,8 +22,8 @@ TBD
22
22
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.
23
23
24
24
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`.
Copy file name to clipboardExpand all lines: docs/contribute/_snippets/tag-processing.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,10 +12,9 @@ Specifically for versioned products, badges will display differently when the `a
12
12
13
13
Example: {applies_to}`stack: removed 99.99`
14
14
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).
17
16
When multiple lifecycle statuses and versions are specified in the sources, several badges are shown.
18
17
19
18
:::{note}
20
19
Visuals and wording in the output documentation are subject to changes and optimizations.
Copy file name to clipboardExpand all lines: docs/contribute/_snippets/tagged-warning.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,5 +3,5 @@ Some repositories use a [tagged branching strategy](/contribute/branching-strate
3
3
4
4
For detailed backporting guidance, refer to the example in [Choose the docs branching strategy for a repository](/contribute/branching-strategy.md#workflow-2-tagged).
5
5
6
-
To determine the published branches for a repository, find the repository in [assembler.yml](https://github.com/elastic/docs-builder/blob/main/src/tooling/docs-assembler/assembler.yml).
6
+
To determine the published branches for a repository, find the repository in [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/config/assembler.yml).
Copy file name to clipboardExpand all lines: docs/contribute/add-repo.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,7 +45,7 @@ Then, successfully run a docs build on the `main` branch. This is a requirement.
45
45
46
46
::::{step} Add the repository to the assembler and navigation configs
47
47
48
-
Edit the [assembler.yml](https://github.com/elastic/docs-builder/blob/main/src/tooling/docs-assembler/assembler.yml) file to add the repository. Refer to [assembler.yml](../configure/site/content.md) for more information.
48
+
Edit the [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/config/assembler.yml) file to add the repository. Refer to [assembler.yml](../configure/site/content.md) for more information.
49
49
50
50
For example, to add the `elastic/yadda-docs` repository:
51
51
@@ -58,7 +58,7 @@ references:
58
58
In this file, you can optionally specify custom branches to deploy docs from, depending on your preferred [branching strategy](branching-strategy.md). You might want to change your branching strategy so you can have more control over when content added for a specific release is published.
59
59
:::
60
60
61
-
Then, edit the [navigation.yml](https://github.com/elastic/docs-builder/blob/main/src/tooling/docs-assembler/navigation.yml) file to add the repository to the navigation.
61
+
Then, edit the [`navigation.yml`](https://github.com/elastic/docs-builder/blob/main/config/navigation.yml) file to add the repository to the navigation.
62
62
63
63
For example, to add the `elastic/yadda-docs` repository under **Reference**:
Copy file name to clipboardExpand all lines: docs/contribute/branching-strategy.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ After it has been established that a repository should publish from a version br
39
39
40
40
1.[Add new triggers to the `docs-build` CI integration](/configure/content-sources.md#ci-configuration). Merge these changes to `main` or `master` and the intended version branches.
41
41
2. Open a PR to trigger the CI integration and confirm that the docs build.
42
-
3. Open a PR updating the [docs assembler file](https://github.com/elastic/docs-builder/blob/main/src/tooling/docs-assembler/assembler.yml):
42
+
3. Open a PR updating the [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/config/assembler.yml):
43
43
* Specify which is the `current` branch for the repository. This branch is the branch from which docs are deployed to production at [elastic.co/docs](http://elastic.co/docs).
44
44
* Specify which is the `next` branch for the repository. The branch defined as `next` publishes docs internally to [staging-website.elastic.co/docs](http://staging-website.elastic.co/docs)
45
45
* Setting this branch to the next version branch in line is a good practice to preview docs change for an upcoming version.
@@ -60,10 +60,10 @@ When you publish from specific version branches, you need to bump the version br
60
60
61
61
Add an action as part of that repo’s release process for the release manager to update this same assembler file and bump the `current` branch with each release, as appropriate. The `next` branch also needs to be bumped if it is not set to `main`.
62
62
63
-
When these releases happen, create a PR against the [assembler file](https://github.com/elastic/docs-builder/blob/main/src/tooling/docs-assembler/assembler.yml) that defines the new `current` branch, to merge on release day.
63
+
When these releases happen, create a PR against the [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/config/assembler.yml) that defines the new `current` branch, to merge on release day.
64
64
65
65
:::{tip}
66
-
Regardless of the branching strategy, you also need to update the current version in [versions.yml](https://github.com/elastic/docs-builder/blob/main/src/Elastic.Documentation.Configuration/versions.yml) as part of your release process. This version number is used in documentation variables and drives our [dynamic version badge logic](/contribute/cumulative-docs.md#how-do-these-tags-behave-in-the-output).
66
+
Regardless of the branching strategy, you also need to update the current version in [`versions.yml`](https://github.com/elastic/docs-builder/blob/main/config/versions.yml) as part of your release process. This version number is used in documentation variables and drives our [dynamic version badge logic](/contribute/cumulative-docs.md#how-do-these-tags-behave-in-the-output).
67
67
:::
68
68
69
69
@@ -123,7 +123,7 @@ The changes must then be backported to their relevant version branches, and no f
123
123
124
124
For example, in a situation where 9.0, 9.1, and 9.2 are already released, and the 9.3 branch has already been cut:
125
125
126
-
* The branch set as `current` in the [docs assembler](https://github.com/elastic/docs-builder/blob/625e75b35841be938a8df76a62deeee811ba52d4/src/tooling/docs-assembler/assembler.yml#L70) is 9.2.
126
+
* The branch set as `current` in the [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/config/assembler.yml) is 9.2.
127
127
* The branch set as `next` (where the content development first happens), is `main`.
128
128
* 9.4 changes are only done on the `main` branch.
129
129
* 9.3 changes are done on the `main` branch and backported to the 9.3 branch.
Copy file name to clipboardExpand all lines: docs/contribute/cumulative-docs.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ This tagging system is mandatory for all of the public-facing documentation. We
31
31
32
32
## How version awareness works in Docs V3
33
33
34
-
Docs V3 uses a central version config called [versions.yml](https://github.com/elastic/docs-builder/blob/main/src/Elastic.Documentation.Configuration/versions.yml), which tracks the latest released versions of our products. It also tracks the earliest version of each product documented in the Docs V3 system (the earliest available on elastic.co/docs).
34
+
Docs V3 uses a central version config called [`versions.yml`](https://github.com/elastic/docs-builder/blob/main/config/versions.yml), which tracks the latest released versions of our products. It also tracks the earliest version of each product documented in the Docs V3 system (the earliest available on elastic.co/docs).
35
35
36
36
This central version config is used in certain inline version variables, and drives our [dynamic rendering logic](#how-do-these-tags-behave-in-the-output). This logic allows us to label documentation related to unreleased versions as `planned`, continuously release documentation, and document our Serverless and {{stack}} offerings in one place.
37
37
@@ -142,4 +142,4 @@ We do not do date-based tagging for unversioned products.
Copy file name to clipboardExpand all lines: docs/syntax/version-variables.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ can be printed in any kind of ways.
28
28
29
29
## Available versioning schemes.
30
30
31
-
This is dictated by the [versions.yml](https://github.com/elastic/docs-builder/blob/main/src/Elastic.Documentation.Configuration/versions.yml) configuration file
31
+
This is dictated by the [`versions.yml`](https://github.com/elastic/docs-builder/blob/main/config/versions.yml) configuration file
0 commit comments