Skip to content

Commit d84a4f2

Browse files
[docs] Clean up cross-repo links (#483)
Follow up to #481 When using cross-repo links, the path should be relative to the `docset.yml` not the full path within the repo ([updated docs-builder docs](https://elastic.github.io/docs-builder/syntax/links/#cross-repository-links)).
1 parent 5a64995 commit d84a4f2

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

docs/reference/_formatters.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ We also support writing logs directly to Elasticsearch or Elastic Cloud. See our
3333
:::::::{tab-set}
3434

3535
::::::{tab-item} Log file
36-
1. Follow the [Filebeat quick start](beats://docs/reference/filebeat/filebeat-installation-configuration.md)
36+
1. Follow the [Filebeat quick start](beats://reference/filebeat/filebeat-installation-configuration.md)
3737
2. Add the following configuration to your `filebeat.yaml` file.
3838

3939
For Filebeat 7.16+
@@ -59,7 +59,7 @@ processors: <5>
5959
2. Values from the decoded JSON object overwrite the fields that {{filebeat}} normally adds (type, source, offset, etc.) in case of conflicts.
6060
3. {{filebeat}} adds an "error.message" and "error.type: json" key in case of JSON unmarshalling errors.
6161
4. {{filebeat}} will recursively de-dot keys in the decoded JSON, and expand them into a hierarchical object structure.
62-
5. Processors enhance your data. See [processors](beats://docs/reference/filebeat/filtering-enhancing-data.md) to learn more.
62+
5. Processors enhance your data. See [processors](beats://reference/filebeat/filtering-enhancing-data.md) to learn more.
6363
6464
6565
For Filebeat < 7.16
@@ -83,8 +83,8 @@ processors:
8383
8484
::::::{tab-item} Kubernetes
8585
1. Make sure your application logs to stdout/stderr.
86-
2. Follow the [Run Filebeat on Kubernetes](beats://docs/reference/filebeat/running-on-kubernetes.md) guide.
87-
3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`).
86+
2. Follow the [Run Filebeat on Kubernetes](beats://reference/filebeat/running-on-kubernetes.md) guide.
87+
3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`).
8888
4. Add these annotations to your pods that log using ECS loggers. This will make sure the logs are parsed appropriately.
8989

9090
```yaml
@@ -101,8 +101,8 @@ annotations:
101101

102102
::::::{tab-item} Docker
103103
1. Make sure your application logs to stdout/stderr.
104-
2. Follow the [Run Filebeat on Docker](beats://docs/reference/filebeat/running-on-docker.md) guide.
105-
3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md).
104+
2. Follow the [Run Filebeat on Docker](beats://reference/filebeat/running-on-docker.md) guide.
105+
3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md).
106106
4. Add these labels to your containers that log using ECS loggers. This will make sure the logs are parsed appropriately.
107107

108108
```yaml
@@ -118,7 +118,7 @@ labels:
118118
::::::
119119

120120
:::::::
121-
For more information, see the [Filebeat reference](beats://docs/reference/filebeat/configuring-howto-filebeat.md).
121+
For more information, see the [Filebeat reference](beats://reference/filebeat/configuring-howto-filebeat.md).
122122

123123

124124

docs/reference/extensions-logging-data-shipper.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ mapped_pages:
77

88
Elastic logger provider for Microsoft.Extensions.Logging.
99

10-
Writes direct to Elasticsearch using the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)), with semantic logging of structured data from message and scope values. The results can be viewed and queried in the Kibana console.
10+
Writes direct to Elasticsearch using the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)), with semantic logging of structured data from message and scope values. The results can be viewed and queried in the Kibana console.
1111

1212
## Installation [_installation_7]
1313

@@ -147,7 +147,7 @@ If `CloudId` is provided, the `ConnectionPoolType` defaults to `Cloud`:
147147

148148
## Output - Elastic Common Schema (ECS) [_output_elastic_common_schema_ecs]
149149

150-
Log messages sent to Elasticsearch follow the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)).
150+
Log messages sent to Elasticsearch follow the [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)).
151151

152152

153153
## Example document [_example_document]

docs/reference/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ mapped_pages:
1010
ECS logging are integrations for your favorite .NET logging libraries. They make it easy to format your logs into ECS-compatible JSON.
1111

1212
::::{tip}
13-
Want to learn more about ECS, ECS logging, and other available language plugins? See the [ECS logging overview](ecs-logging://docs/reference/intro.md).
13+
Want to learn more about ECS, ECS logging, and other available language plugins? See the [ECS logging overview](ecs-logging://reference/intro.md).
1414
::::
1515

1616

docs/reference/log4net-formatter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Any valid ECS log template properties that is available under `LogTemplateProper
5656

5757
## Output [_output]
5858

59-
Apart from [mandatory fields](ecs://docs/reference/ecs-guidelines.md#_general_guidelines), the output contains additional data:
59+
Apart from [mandatory fields](ecs://reference/ecs-guidelines.md#_general_guidelines), the output contains additional data:
6060

6161
* `log.origin.file.name` is taken from `LocationInformation`
6262
* `log.origin.file.line` is taken from `LocationInformation`

docs/reference/setup.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Choose one of our data shipping loggers:
2727

2828
## Step 2: Enable APM log correlation (optional) [setup-step-2]
2929

30-
If you are using the Elastic APM .NET agent, [log correlation can be configured](apm-agent-dotnet://docs/reference/logs.md) to inject trace, transaction and span id fields into log events.
30+
If you are using the Elastic APM .NET agent, [log correlation can be configured](apm-agent-dotnet://reference/logs.md) to inject trace, transaction and span id fields into log events.
3131

3232
By default the ECS logging integrations will read tracing information from [System.Diagnostics.Activity](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.activity?view=net-7.0) if the APM logging corrolation libraries are not installed.
3333

@@ -39,7 +39,7 @@ If you are using one of our log formatters you can use the following methods to
3939
:::::::{tab-set}
4040

4141
::::::{tab-item} Log file
42-
1. Follow the [Filebeat quick start](beats://docs/reference/filebeat/filebeat-installation-configuration.md)
42+
1. Follow the [Filebeat quick start](beats://reference/filebeat/filebeat-installation-configuration.md)
4343
2. Add the following configuration to your `filebeat.yaml` file.
4444

4545
For Filebeat 7.16+
@@ -65,7 +65,7 @@ processors: <5>
6565
2. Values from the decoded JSON object overwrite the fields that {{filebeat}} normally adds (type, source, offset, etc.) in case of conflicts.
6666
3. {{filebeat}} adds an "error.message" and "error.type: json" key in case of JSON unmarshalling errors.
6767
4. {{filebeat}} will recursively de-dot keys in the decoded JSON, and expand them into a hierarchical object structure.
68-
5. Processors enhance your data. See [processors](beats://docs/reference/filebeat/filtering-enhancing-data.md) to learn more.
68+
5. Processors enhance your data. See [processors](beats://reference/filebeat/filtering-enhancing-data.md) to learn more.
6969
7070
7171
For Filebeat < 7.16
@@ -89,8 +89,8 @@ processors:
8989
9090
::::::{tab-item} Kubernetes
9191
1. Make sure your application logs to stdout/stderr.
92-
2. Follow the [Run Filebeat on Kubernetes](beats://docs/reference/filebeat/running-on-kubernetes.md) guide.
93-
3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`).
92+
2. Follow the [Run Filebeat on Kubernetes](beats://reference/filebeat/running-on-kubernetes.md) guide.
93+
3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md) (uncomment the corresponding section in `filebeat-kubernetes.yaml`).
9494
4. Add these annotations to your pods that log using ECS loggers. This will make sure the logs are parsed appropriately.
9595

9696
```yaml
@@ -107,8 +107,8 @@ annotations:
107107

108108
::::::{tab-item} Docker
109109
1. Make sure your application logs to stdout/stderr.
110-
2. Follow the [Run Filebeat on Docker](beats://docs/reference/filebeat/running-on-docker.md) guide.
111-
3. Enable [hints-based autodiscover](beats://docs/reference/filebeat/configuration-autodiscover-hints.md).
110+
2. Follow the [Run Filebeat on Docker](beats://reference/filebeat/running-on-docker.md) guide.
111+
3. Enable [hints-based autodiscover](beats://reference/filebeat/configuration-autodiscover-hints.md).
112112
4. Add these labels to your containers that log using ECS loggers. This will make sure the logs are parsed appropriately.
113113

114114
```yaml
@@ -124,5 +124,5 @@ labels:
124124
::::::
125125

126126
:::::::
127-
For more information, see the [Filebeat reference](beats://docs/reference/filebeat/configuring-howto-filebeat.md).
127+
For more information, see the [Filebeat reference](beats://reference/filebeat/configuring-howto-filebeat.md).
128128

0 commit comments

Comments
 (0)