Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] fix broken links to examples #1265

Merged
merged 1 commit into from
Jul 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cluster_agent_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ datadog-cluster-agent-9f9c5c4c-pmhqb 1/1 Running 0 58s
datadog-agent-hjlbg 1/1 Running 0 33s
```

[1]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/v2alpha1/datadog-agent-with-clusteragent.yaml
[1]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/datadog-agent-with-clusteragent.yaml
10 changes: 5 additions & 5 deletions docs/configuration.v2alpha1.md
Original file line number Diff line number Diff line change
Expand Up @@ -373,8 +373,8 @@ In the table, `spec.override.nodeAgent.image.name` and `spec.override.nodeAgent.
| [key].tolerations `[]object` | Configure the component tolerations. |
| [key].volumes `[]object` | Specify additional volumes in the different components (Datadog Agent, Cluster Agent, Cluster Check Runner). |

[1]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/v2alpha1/datadog-agent-all.yaml
[2]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/v2alpha1/datadog-agent-with-logs-apm.yaml
[3]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/v2alpha1/datadog-agent-with-apm-hostport.yaml
[4]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/v2alpha1/datadog-agent-with-clusteragent.yaml
[5]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/v2alpha1/datadog-agent-with-tolerations.yaml
[1]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/datadog-agent-all.yaml
[2]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/datadog-agent-with-logs-apm.yaml
[3]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/datadog-agent-with-apm-hostport.yaml
[4]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/datadog-agent-with-clusteragent.yaml
[5]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/datadog-agent-with-tolerations.yaml
4 changes: 2 additions & 2 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,6 @@ helm delete my-datadog-operator
[4]: https://app.datadoghq.com/account/settings#api
[5]: https://github.com/DataDog/datadog-operator/blob/main/docs/configuration.v2alpha1.md
[6]: https://gcr.io/datadoghq
[7]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/v2alpha1/datadog-agent-with-registry.yaml
[7]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/datadog-agent-with-registry.yaml
[8]: https://gallery.ecr.aws/datadog/
[9]: https://github.com/DataDog/datadog-operator/blob/main/docs/integrations_autodiscovery.md
[9]: https://github.com/DataDog/datadog-operator/blob/main/docs/integrations_autodiscovery.md
4 changes: 2 additions & 2 deletions docs/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Notes:
Create a secret that contains an `api-key` and an `app-key`. By default the Operator is installed in the
`system` namespace, and only watches resources in this namespace. As a result, the secret and deployment must be within the same namespace.

Apply the `examples/datadogagent/v2alpha1/min.yaml` file which contains the mininum configuration needed to deploy the Agent and related services.
Apply the `examples/datadogagent/datadog-agent-minimum.yaml` file which contains the mininum configuration needed to deploy the Agent and related services.

The following commands show how to execute these steps:

Expand All @@ -70,7 +70,7 @@ kubectl -n $KUBE_NAMESPACE create secret generic datadog-secret --from-literal a
kubectl -n $KUBE_NAMESPACE create secret generic datadog-token --from-literal token=$DD_TOKEN


kubectl -n $KUBE_NAMESPACE apply -f examples/datadogagent/v2alpha1/min.yaml
kubectl -n $KUBE_NAMESPACE apply -f examples/datadogagent/datadog-agent-minimum.yaml
```


Expand Down
10 changes: 5 additions & 5 deletions hack/generate-docs/v2alpha1_footer.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

[1]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/v2alpha1/datadog-agent-all.yaml
[2]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/v2alpha1/datadog-agent-with-logs-apm.yaml
[3]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/v2alpha1/datadog-agent-with-apm-hostport.yaml
[4]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/v2alpha1/datadog-agent-with-clusteragent.yaml
[5]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/v2alpha1/datadog-agent-with-tolerations.yaml
[1]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/datadog-agent-all.yaml
[2]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/datadog-agent-with-logs-apm.yaml
[3]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/datadog-agent-with-apm-hostport.yaml
[4]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/datadog-agent-with-clusteragent.yaml
[5]: https://github.com/DataDog/datadog-operator/blob/main/examples/datadogagent/datadog-agent-with-tolerations.yaml
Loading