feat: fixes broken links, updates screenshots in docs, and misc. items (

#42)

Fixes the below issues:
- "Edit this page" link goes to 404 (blob/main) is missing
- "Read more" metrics link is broken,
https://github.com/microsoft/retina/blob/main/docs/metrics/intro.md
- Pictures are too small to read,
https://retina.sh/docs/troubleshooting/basic-metrics#check-if-managed-prometheus-is-scraping-retina-metrics
- Not found: https://retina.sh/docs/metrics/managed-retina
- Go 1.18 or newer but the go.mod is at least 1.21
- Agent Config missing code block, annotation is code blocked in other
locations
- The contributing and grafana page labeled as FIXME,
retina/docs/contributing/readme.md, retina/docs/installation/grafana.md
- Configuring grafana is not linked on the side bar
- The configure grafana page itself also does not have a side bar

Manually tested.

README.md

@@ -14,20 +14,20 @@ Retina is currently supported in AKS. It has two major features:
 
 ### Metrics
 
-[Read more](docs/metrics/intro.md)
+[Read more](https://retina.sh/docs/metrics/modes)
 
 ### Quick Install Guide
 
 1. Create a Kubernetes cluster with a minimum of 2 nodes. Retina supports Linux (Ubuntu) and Windows (2019 and 2022) nodes.
-2. Follow steps in [Using Managed Prometheus and Grafana](https://retina.sh/docs/metrics/managed-retina)
+2. Follow steps in [Using Managed Prometheus and Grafana](https://retina.sh/docs/installation/prometheus-azure-managed)
 
 ### Captures
 
-[Read more](docs/captures/readme.md)
+[Read more](https://retina.sh/docs/captures)
 
 ## Contributing
 
-[Read more](docs/contributing/readme.md)
+[Read more](https://retina.sh/docs/contributing)
 
 This project welcomes contributions and suggestions.  Most contributions require you to agree to a
 Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us

docs/contributing/readme.md

@@ -16,8 +16,6 @@ contact [[email protected]](mailto:[email protected]) with any additio
 
 ### Configurations
 
-FIXME just link the Config page
-
 Configurations are passed through `retina-config` configmap in `retina` namespace. Following configurations are currently supported:
 
 - `apiserver.port` : the port for `retina-agent` Pod
@@ -27,9 +25,11 @@ Configurations are passed through `retina-config` configmap in `retina` namespac
 
 Note: Changes to configmap after retina is deployed would require re-deployment of `retina-agent`.
 
+See the [Configuration](https://retina.sh/docs/metrics/configuration) page for further details.
+
 ### Supported Metrics Plugins
 
-FIXME just link metrics page
+See the [Plugins](https://retina.sh/docs/metrics/plugins/packetforward) pages for a list of supported plugins.
 
 ### Pre-Requisites
 

docs/installation/cli.md

@@ -19,5 +19,5 @@ make install-kubectl-retina
 
 Requirements:
 
-- go 1.18 or newer
+- go 1.21 or newer
 - GNU make

docs/installation/config.md

@@ -9,7 +9,7 @@ Defaults are specified for each component in *deploy/manifests/controller/helm/r
 
 * `enablePodLevel`: When this toggle is set to true, Retina will gather Advanced/Pod-Level metrics. Advanced metrics can attach Pod metadata to Retina's metrics.
 * `remoteContext`: When this toggle is set to true, retina will watch Pods on the cluster.
-* `enableAnnotations`: When this toggle is set to true, retina will gather metrics for the annotated resources. Namespaces or Pods can be annotated with "retina.sh/v1alpha=observe". The operator and enableRetinaEndpoint for the operator should be enabled.
+* `enableAnnotations`: When this toggle is set to true, retina will gather metrics for the annotated resources. Namespaces or Pods can be annotated with `retina.sh/v1alpha=observe`. The operator and enableRetinaEndpoint for the operator should be enabled.
 * `enabledPlugin_linux`: Array of enabled plugins for linux.
 * `enabledPlugin_win`: Array of enabled plugins for windows.
 * `metricsInterval`: the interval for which metrics will be gathered.

docs/installation/grafana.md

@@ -25,8 +25,6 @@ Make sure that you're still port-forwarding your server to localhost:9090, or co
 
    ![alt text](img/grafana-dashboard.png)
 
-FIXME add published dashboard links
-
 ## Pre-Installed Dashboards
 
 If you're using [Azure-Hosted Prometheus/Grafana](prometheus-azure-managed.md), versions of these dashbaords are pre-installed under:

docs/troubleshooting/basic-metrics.md

@@ -146,15 +146,17 @@ If you are using managed Prometheus, you can check if it is scraping the retina
     http://localhost:9090/targets
     ```
 
-    ![alt text](imgs/prometheus-retina-targets.png)
+    ![alt text](imgs/prometheus-retina-targets1.png)
+    ![alt text](imgs/prometheus-retina-targets2.png)
 
     a. check if service discovery is recognizing retina Pods
 
     ```shell
     http://localhost:9090/service-discovery#retina-pods
     ```
 
-    ![alt text](imgs/prom-retina-service-discovery.png)
+    ![alt text](imgs/prom-retina-service-discovery1.png)
+    ![alt text](imgs/prom-retina-service-discovery2.png)
 
 4. If Retina Pods are not discovered then please check prometheus configuration and make sure the Retina Pod's job is added to the scrape config.
 

site/docusaurus.config.js

@@ -44,7 +44,7 @@ const config = {
           path: '../docs',
           //routeBasePath: '../docs',
           editUrl:
-            'https://github.com/microsoft/retina/docs',
+            'https://github.com/microsoft/retina/blob/main/docs',
         },
         theme: {
           customCss: require.resolve('./src/css/custom.css'),

site/sidebars.js

@@ -27,6 +27,7 @@ const sidebars = {
         'installation/setup',
         'installation/prometheus-unmanaged',
         'installation/prometheus-azure-managed',
+        'installation/grafana',
         'installation/cli',
         'installation/config',
       ],