Skip to content

Commit 2600b27

Browse files
authored
docs: fix broken links to retina.sh/docs (#1340)
# Description This PR fixes broken links to the contributing guide and other `retina.sh/docs` pages. ## Related Issue Resolves #1333 ## Checklist - [x] I have read the [contributing documentation](https://retina.sh/docs/contributing). - [x] I signed and signed-off the commits (`git commit -S -s ...`). See [this documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) on signing commits. - [x] I have correctly attributed the author(s) of the code. - [x] I have tested the changes locally. - [x] I have followed the project's style guidelines. - [x] I have updated the documentation, if necessary. - [ ] I have added tests, if applicable. ## Screenshots (if applicable) or Testing Completed N/A ## Additional Notes I also adjusted some working links to `retina.sh/docs` to avoid a brief "Page Not Found" flash before loading. --- Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more information on how to contribute to this project. Signed-off-by: Paulina Kalicka <[email protected]>
1 parent 769bc7a commit 2600b27

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

.github/pull_request_template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ If this pull request is related to any issue, please mention it here. Additional
88

99
## Checklist
1010

11-
- [ ] I have read the [contributing documentation](https://retina.sh/docs/contributing).
11+
- [ ] I have read the [contributing documentation](https://retina.sh/docs/Contributing/overview).
1212
- [ ] I signed and signed-off the commits (`git commit -S -s ...`). See [this documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) on signing commits.
1313
- [ ] I have correctly attributed the author(s) of the code.
1414
- [ ] I have tested the changes locally.

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ This will add a `Signed-off-by` trailer to your Git commit, affirming your accep
3131

3232
## More info
3333

34-
Getting started guides, community meetings, and more can be found on the [Retina website](https://retina.sh/docs/contributing).
34+
Getting started guides, community meetings, and more can be found on the [Retina website](https://retina.sh/docs/Contributing/overview).

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Retina **collects customizable telemetry**, which can be exported to **multiple
2727

2828
## Why Retina?
2929

30-
Retina lets you **investigate network issues on-demand** and **continuously monitor your clusters**. For scenarios where Retina shines, see the intro docs [here](https://retina.sh/docs/intro)
30+
Retina lets you **investigate network issues on-demand** and **continuously monitor your clusters**. For scenarios where Retina shines, see the intro docs [here](https://retina.sh/docs/Introduction/intro)
3131

3232
## Documentation
3333

@@ -37,8 +37,8 @@ See [retina.sh](http://retina.sh) for documentation and examples.
3737

3838
Retina has two major features:
3939

40-
- [Metrics](https://retina.sh/docs/metrics/modes)
41-
- [Captures](https://retina.sh/docs/captures/overview)
40+
- [Metrics](https://retina.sh/docs/Metrics/modes)
41+
- [Captures](https://retina.sh/docs/Captures/overview)
4242

4343
### Metrics Quick Install Guide
4444

@@ -57,7 +57,7 @@ helm upgrade --install retina oci://ghcr.io/microsoft/retina/charts/retina \
5757

5858
Set the `version` and image `tag` arguments to the desired version, if different.
5959

60-
After Helm install, follow steps in [Using Prometheus and Grafana](https://retina.sh/docs/installation/grafana/prometheus-unmanaged) to set up metrics collection and visualization.
60+
After Helm install, follow the steps for setting up [Prometheus](https://retina.sh/docs/Installation/prometheus) and [Grafana](https://retina.sh/docs/Installation/grafana) to configure metrics collection and visualization.
6161

6262
### Captures Quick Start Guide
6363

@@ -69,7 +69,7 @@ The preferred way to install the Retina CLI using [Krew](https://krew.sigs.k8s.i
6969
kubectl krew install retina
7070
```
7171

72-
Other installation options are documented in [CLI Installation](https://retina.sh/docs/installation/cli).
72+
Other installation options are documented in [CLI Installation](https://retina.sh/docs/Installation/CLI).
7373

7474
Verify installation:
7575

@@ -84,7 +84,7 @@ To quickly start creating a capture:
8484
kubectl retina capture create --name <my-capture> --namespace <my-namespace> --selector <app=my-app>
8585
```
8686

87-
For further CLI documentation, see [Capture with Retina CLI](https://retina.sh/docs/captures/cli).
87+
For further CLI documentation, see [Capture with Retina CLI](https://retina.sh/docs/Captures/cli).
8888

8989
#### Captures via CRD
9090

@@ -105,7 +105,7 @@ helm upgrade --install retina oci://ghcr.io/microsoft/retina/charts/retina \
105105
--set enabledPlugin_linux="\[dropreason\,packetforward\,linuxutil\,dns\,packetparser\]"
106106
```
107107

108-
Then follow steps in [Capture CRD](https://retina.sh/docs/captures/#option-2-capture-crd-custom-resource-definition) for documentation of the CRD and examples for setting up Captures.
108+
Then follow steps in [Capture CRD](https://retina.sh/docs/Captures/overview/#option-2-capture-crd-custom-resource-definition) for documentation of the CRD and examples for setting up Captures.
109109

110110
## Contributing
111111

@@ -121,7 +121,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
121121
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
122122
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
123123

124-
[Read more about how to begin contributing here.](https://retina.sh/docs/contributing)
124+
[Read more about how to begin contributing here.](https://retina.sh/docs/Contributing/overview)
125125

126126
### Verify signed images
127127

@@ -136,7 +136,7 @@ cosign verify ghcr.io/$REPO/$IMAGE:$TAG --certificate-oidc-issuer https://token.
136136

137137
### Office Hours and Community Meetings
138138

139-
We host a periodic open community meeting. [Find the details here.](https://retina.sh/docs/contributing/#office-hours-and-community-meetings)
139+
We host a periodic open community meeting. [Find the details here.](https://retina.sh/docs/Contributing/overview#office-hours-and-community-meetings)
140140

141141
## Trademarks
142142

docs/03-Metrics/plugins/Linux/dns.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The `dns` plugin requires the `CAP_SYS_ADMIN` capability.
1212

1313
This plugin uses [Inspektor Gadget](https://github.com/inspektor-gadget/inspektor-gadget)'s DNS Tracer to track DNS traffic and generate basic metrics derived from the captured events.
1414

15-
In [Advanced mode](https://retina.sh/docs/metrics/modes), the plugin further processes the capture results into an enriched Flow with additional Pod information. Subsequently, the Flow is transmitted to an external channel. This allows a DNS module to generate additional Pod-Level metrics.
15+
In [Advanced mode](https://retina.sh/docs/Metrics/modes), the plugin further processes the capture results into an enriched Flow with additional Pod information. Subsequently, the Flow is transmitted to an external channel. This allows a DNS module to generate additional Pod-Level metrics.
1616

1717
### Code locations
1818

0 commit comments

Comments
 (0)