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
Elastic documentation is built from many assembled repositories using `docs-assembler`. Adding a new repository requires making the assembly process aware of its existence.
4
+
5
+
Follow these instructions to add a new docs repository.
6
+
7
+
## Prerequisites
8
+
9
+
The new docs repository needs to satisfy these requirements:
10
+
11
+
- The repository must have a `docs` folder in the root.
12
+
- The `docs` folder must contain a valid [`docset.yml` file](../configure/content-set/navigation.md) and Markdown files.
13
+
- Markdown files within the `docs` folder that follow the V3 format. Refer to [Syntax](../syntax/index.md).
14
+
- The repository must be within the Elastic organization on `GitHub` and public.
15
+
16
+
## Add the repository
17
+
18
+
Follow these instructions to add a new repository to the docs.
19
+
20
+
:::::{stepper}
21
+
22
+
::::{step} Add the repo to docs-infra
23
+
24
+
Add the repo to the list of repositories that can upload to the Link index by editing the [repositories.yml](https://github.com/elastic/docs-infra/blob/main/modules/aws-github-actions-oidc-roles/repositories.yml) file.
25
+
26
+
For example, to add the fictitious `elastic/yadda-docs` repository:
27
+
28
+
```yaml
29
+
repositories:
30
+
- name: elastic/yadda-docs # Added for testing purposes
31
+
```
32
+
33
+
::::
34
+
35
+
::::{step} Add the workflow actions to the repository
36
+
37
+
Add the following actions to the `.github/workflows` directory of your repo:
Then, successfully run a docs build on the `main` branch. This is a requirement. For example, you can merge a docs pull request to `main` after adding the workflow actions.
43
+
44
+
::::
45
+
46
+
::::{step} Add the repository to the assembler and navigation configs
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.
49
+
50
+
For example, to add the `elastic/yadda-docs` repository:
51
+
52
+
```yaml
53
+
references:
54
+
yadda-docs:
55
+
```
56
+
57
+
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.
58
+
59
+
For example, to add the `elastic/yadda-docs` repository under **Reference**:
Copy file name to clipboardExpand all lines: docs/syntax/links.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,24 +15,26 @@ It has two components:
15
15
16
16
### Internal links
17
17
18
-
Link between documentation files using either relative or absolute paths.
18
+
Link between documentation pages in the same repository using the file’s relative or absolute path. The path must include the `.md` file extension. Optionally append an anchor to send readers to a specific section on a page. Never use a full URL for links between documentation pages.
19
19
20
20
#### Relative paths
21
-
Navigate relative to the current file's location:
21
+
22
+
Use relative paths to link to other pages inside the same repository.
22
23
23
24
```markdown
24
-
[Security documentation](../security/index.md)
25
+
[Security docs](../security/index.md)
25
26
26
-
[Monitoring guide](monitor/index.md)
27
+
[Install](monitor/index.md#installation)
27
28
```
28
29
29
30
#### Absolute paths
30
31
31
-
You can also use absolute paths to link to pages within the same repository.
32
-
Say you're working on a random page somewhere in the `docs-content` repo. You can link to a page in the `deploy-manage` section like this:
32
+
Use absolute paths to link to other pages inside the same repository.
To follow this tutorial you will need to install the following components:
4
37
5
38
- An installation of Elasticsearch, based on our hosted [Elastic Cloud](https://www.elastic.co/cloud) service (which includes a free trial period), or a self-hosted service that you run on your own computer. See the Install Elasticsearch section above for installation instructions.
@@ -9,4 +42,4 @@ The tutorial assumes that you have no previous knowledge of Elasticsearch or gen
9
42
10
43
- Python development
11
44
- The [Flask](https://flask.palletsprojects.com/) web framework for Python.
12
-
- The command prompt or terminal application in your operating system.
45
+
- The command prompt or terminal application in your operating system.
0 commit comments