docs: Add vscode documentaiton in main retina repo.

microsoft · Feb 9, 2025 · c1ace6b · c1ace6b
1 parent 75600a6
commit c1ace6b
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 2 deletions.
diff --git a/docs/01-Introduction/02-architecture.md b/docs/01-Introduction/02-architecture.md
@@ -10,7 +10,7 @@ To collect this data, Retina observes and hooks on to system events within the k
 
 This section discusses how Retina collects its raw data. More specifically, it discusses how the eBPF programs and plugins are used.
 
-The plugins have a very specific scope by design, and Retina is designed to be extendable, meaning it is easy to add in additional plugins if necessary. If there is a plugin missing for your use case, you can create your own! See our [Development page](../07-Contributing/02-development.md) for details on how to get started.
+The plugins have a very specific scope by design, and Retina is designed to be extendable, meaning it is easy to add in additional plugins if necessary. If there is a plugin missing for your use case, you can create your own! See our [Development page](../08-Contributing/02-development.md) for details on how to get started.
 
 The plugins are responsible for installing the eBPF programs into the host kernel during startup. These eBPF programs collect metrics from events in the kernel level, which are then passed to the user space where they are parsed and converted into a `flow` data structure. Depending on the Control Plane being used, the data will either be sent to a Retina Enricher, or written to an external channel which is consumed by a Hubble observer - more on this in the [Control Plane](#control-plane) section below. It is not required for a plugin to use eBPF, it can also use syscalls or other API calls. In either case, the plugins will implement the same [interface](https://github.com/microsoft/retina/blob/main/pkg/plugin/registry/registry.go).
 

diff --git a/docs/07-Consumingtools/vscode.md b/docs/07-Consumingtools/vscode.md
@@ -0,0 +1,23 @@
+# Retina Integration in AKS VS Code Extension
+
+## Overview
+
+Retina is a powerful feature integrated into the Azure Kubernetes Service (AKS) VS Code extension, enabling users to capture and analyze workloads efficiently. This integration simplifies debugging and troubleshooting by providing deep insights into Kubernetes applications.
+
+## Integration Details
+
+The AKS VS Code extension incorporates Retina to enhance cluster observability by capturing snapshots of workloads, logs, and events in real time. Users can:
+
+- Capture workload snapshots directly within VS Code.
+- Analyze Kubernetes resources and identify issues.
+- Improve troubleshooting efficiency with detailed insights.
+
+## How to Use Retina in the AKS VS Code Extension
+
+1. Install the **Azure Kubernetes Service** extension in VS Code.
+2. Connect to an AKS cluster.
+3. Navigate to the **Retina Capture** feature.
+4. Capture and analyze workloads seamlessly within the VS Code environment.
+
+For a detailed guide on using Retina in AKS, visit:
+[Retina Capture in AKS VS Code Extension](https://azure.github.io/vscode-aks-tools/features/retina-capture.html)
diff --git a/docs/07-Contributing/01-overview.md → docs/08-Contributing/01-overview.md b/docs/07-Contributing/01-overview.md → docs/08-Contributing/01-overview.md
diff --git a/docs/07-Contributing/02-development.md → docs/08-Contributing/02-development.md b/docs/07-Contributing/02-development.md → docs/08-Contributing/02-development.md
diff --git a/site/docusaurus.config.ts b/site/docusaurus.config.ts
@@ -142,7 +142,7 @@ const config = {
           items: [
             {
               label: "Contribute",
-              href: "https://github.com/microsoft/retina/tree/main/docs/07-Contributing",
+              href: "https://github.com/microsoft/retina/tree/main/docs/08-Contributing",
             },
             {
               label: "Github",