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
# 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]>
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ If this pull request is related to any issue, please mention it here. Additional
8
8
9
9
## Checklist
10
10
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).
12
12
-[ ] 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.
13
13
-[ ] I have correctly attributed the author(s) of the code.
Copy file name to clipboardExpand all lines: README.md
+9-9
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ Retina **collects customizable telemetry**, which can be exported to **multiple
27
27
28
28
## Why Retina?
29
29
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)
31
31
32
32
## Documentation
33
33
@@ -37,8 +37,8 @@ See [retina.sh](http://retina.sh) for documentation and examples.
Set the `version` and image `tag` arguments to the desired version, if different.
59
59
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.
61
61
62
62
### Captures Quick Start Guide
63
63
@@ -69,7 +69,7 @@ The preferred way to install the Retina CLI using [Krew](https://krew.sigs.k8s.i
69
69
kubectl krew install retina
70
70
```
71
71
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).
73
73
74
74
Verify installation:
75
75
@@ -84,7 +84,7 @@ To quickly start creating a capture:
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.
109
109
110
110
## Contributing
111
111
@@ -121,7 +121,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
121
121
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
Copy file name to clipboardExpand all lines: docs/03-Metrics/plugins/Linux/dns.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ The `dns` plugin requires the `CAP_SYS_ADMIN` capability.
12
12
13
13
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.
14
14
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.
0 commit comments