Make all links relative and fix broken links to nested headers. (#177)

htroisi · web-flow · commit be080f3679a0 · 2022-04-26T13:59:00.000-07:00
* Add short redirect for Troubleshooting page.
* Use relative links.
* Fix broken links to nested headers.

Signed-off-by: Hannah Troisi &lt;htroisi@pixielabs.ai&gt;
diff --git a/content/en/01-about-pixie/01-what-is-pixie.md b/content/en/01-about-pixie/01-what-is-pixie.md
@@ -17,7 +17,7 @@ Pixie was contributed by [New Relic, Inc.](https://newrelic.com/) to the [Cloud
 
 * **Auto-telemetry**: Pixie uses eBPF to automatically collect telemetry data such as full-body requests, resource and network metrics, application profiles, and [more](/about-pixie/data-sources).
 
-* **In-cluster edge compute**: Pixie collects, stores and queries all telemetry data [locally in the cluster](/about-pixie/faq#where-does-pixie-store-its-data). Pixie uses less than 5% of cluster CPU, and in most cases less than 2%.
+* **In-cluster edge compute**: Pixie collects, stores and queries all telemetry data [locally in the cluster](/about-pixie/faq#data-collection-where-does-pixie-store-its-data). Pixie uses less than 5% of cluster CPU, and in most cases less than 2%.
 
 * **Scriptability**: [PxL](/reference/pxl/), Pixie’s flexible Pythonic query language, can be used across Pixie’s UI, CLI, and client APIs. Pixie provides a set of [community scripts](https://github.com/pixie-io/pixie/tree/main/src/pxl_scripts) for common [use cases](/tutorials/pixie-101).
 
diff --git a/content/en/01-about-pixie/04-roadmap.md b/content/en/01-about-pixie/04-roadmap.md
@@ -21,7 +21,7 @@ Pixie’s edge compute engine allows us to apply ML/AI on unsampled data. We wil
 
 ### Support the ecosystem
 
-Pixie has a versatile execution engine which can ingest and export data in a variety of formats. Pixie currently supports [exporting data in the OpenTelemetry format](/tutorials/integrations/otel/) which enables developers to consume Pixie data along with data produced by other tools (Jaeger, Prometheus. We plan to add ingest in the future. We also plan to leverage our [client APIs](/reference/api) in order to support tighter integrations with other open source projects.
+Pixie has a versatile execution engine which can ingest and export data in a variety of formats. Pixie currently supports [exporting data in the OpenTelemetry format](/tutorials/integrations/otel/) which enables developers to consume Pixie data along with data produced by other tools (Jaeger, Prometheus). We plan to add ingest in the future. We also plan to leverage our [client APIs](/reference/api) in order to support tighter integrations with other open source projects.
 
 ### Non-goals
 
diff --git a/content/en/01-about-pixie/05-faq.md b/content/en/01-about-pixie/05-faq.md
@@ -122,7 +122,7 @@ Typical performance overhead for node CPU usage is between 2-5%, depending on th
 
 ### Which languages are supported for continuous profiling?
 
-Go, C++ and Rust are currently supported. The [Roadmap](/about-pixie/roadmap) contains plans to expand support to other languages.
+Pixie's [continuous profiler](/tutorials/pixie-101/profiler/) currently supports Go, C++, Rust and Java. The [Roadmap](/about-pixie/roadmap) contains plans to expand support to other languages.
 
 ## How do I...?
 
diff --git a/content/en/01-about-pixie/06-troubleshooting.md b/content/en/01-about-pixie/06-troubleshooting.md
@@ -3,6 +3,8 @@ title: "Troubleshooting"
 metaTitle: "About Pixie | Troubleshooting"
 metaDescription: "Troubleshooting problems with Pixie."
 order: 6
+redirect_from:
+    - /troubleshooting
 ---
 
 This page describes how to troubleshoot Pixie. We frequently answer questions on our [community Slack](https://slackin.px.dev/) channel and in response to [GitHub issues](https://github.com/pixie-io/pixie/issues). You can also check those two places to see if your question has already been addressed. To better understand how Pixie's various components interact, please see the [Architecture](/reference/architecture) overview.
@@ -75,7 +77,7 @@ This step of the deployment checks that the Cloud Connector can successfully com
 
 Confirm that all of the `pl` and `px-operator` namespace pods are ready and available using `px debug pods`. Deploying Pixie usually takes anywhere between 5-7 minutes. Once Pixie is deployed, it can take a few minutes for the UI to show that the cluster is healthy.
 
-To debug, follow the steps in the “Deploy with CLI fails to pass health checks” section in the [above question](/about-pixie/faq/#my-deployment-is-stuck-fails). As long as the Kelvin pod, plus at least one PEM pod is up and running, then your cluster should not show as unavailable.
+To debug, follow the steps in the “Deploy with CLI fails to pass health checks” section in the [above question](/about-pixie/troubleshooting/#troubleshooting-deployment-my-deployment-is-stuck-fails). As long as the Kelvin pod, plus at least one PEM pod is up and running, then your cluster should not show as unavailable.
 
 ## Troubleshooting Operation
 
@@ -105,7 +107,7 @@ If specific services / requests are missing, it is possible that your applicatio
 
 ### Why can’t I see application profiles / flamegraphs for my pod / node?
 
-Continuous profiling currently only supports Go/C++/Rust. The [Roadmap](/about-pixie/roadmap) contains plans to expand this support to Java, Ruby, Python, etc.
+Pixie's [continuous profiler](/tutorials/pixie-101/profiler/) currently supports Go, C++, Rust and Java. Java support is a beta feature and must be [manually enabled](/tutorials/pixie-101/profiler/#prerequisites-enabling-java-support). For best results, run Java applications with `-XX:+PreserveFramePointer`.
 
 ### Why is the vizier-pem pod’s memory increasing?
 
diff --git a/content/en/02-installing-pixie/01-requirements.md b/content/en/02-installing-pixie/01-requirements.md
@@ -78,7 +78,7 @@ The following is a list of Linux distributions that have been tested.
 | Ubuntu       |  18.04+               |
 | Debian       |  10+                  |
 | RHEL         |  8+                   |
-| COS          |  73+                  |
+| CentOS       |  7.3+                  |
 
 Pixie may also work on other distributions.
 
diff --git a/content/en/02-installing-pixie/03-install-guides/02-self-hosted-pixie.md b/content/en/02-installing-pixie/03-install-guides/02-self-hosted-pixie.md
@@ -20,7 +20,7 @@ Get Pixie fully managed with [Pixie Community Cloud](/installing-pixie/install-g
 ## 1. Deploy Pixie Cloud
 
 <Alert variant="outlined" severity="info">
-  Pixie also offers a free account with Pixie Community Cloud to make getting started even easier and faster. To get Pixie Cloud, check out the community cloud <a href="https://docs.px.dev/installing-pixie/install-guides/community-cloud-for-pixie">Install Guide</a>.
+  Pixie also offers a free account with Pixie Community Cloud to make getting started even easier and faster. To get Pixie Cloud, check out the community cloud <a href="/installing-pixie/install-guides/community-cloud-for-pixie">Install Guide</a>.
 </Alert>
 
 <Alert variant="outlined" severity="warning">
diff --git a/content/en/03-using-pixie/01-using-live-ui.md b/content/en/03-using-pixie/01-using-live-ui.md
@@ -114,5 +114,5 @@ To run an [example script](https://github.com/pixie-io/pixie-demos/tree/main/end
 5. Show / hide the script editor using the `ctrl+e` (Windows, Linux) or `cmd+e` (Mac). Alternatively, use the `Open editor` button in the top right.
 
 <Alert variant="outlined" severity="info">
-  Pixie's Live UI will soon support script persistence, but at the moment, any scripts modified in the Live UI will be lost if you refresh or switch to a different script. For extensive script development, we recommend using the <a href="https://docs.px.dev/tutorials/pxl-scripts/script-dev-environment/">Script Developer Environment</a>
+  Pixie's Live UI will soon support script persistence, but at the moment, any scripts modified in the Live UI will be lost if you refresh or switch to a different script. For extensive script development, we recommend using the <a href="/tutorials/pxl-scripts/script-dev-environment/">Script Developer Environment</a>
 </Alert>
diff --git a/content/en/04-tutorials/01-pixie-101/02-infra-health.md b/content/en/04-tutorials/01-pixie-101/02-infra-health.md
@@ -103,7 +103,7 @@ by clicking the bottom box.
 :::
 
 <Alert variant="outlined" severity="info">
-  To learn more about how use Pixie for application profiling, check out the <a href="https://docs.px.dev/tutorials/pixie-101/profiler/">Profiling with Flamegraphs</a> tutorial.
+  To learn more about how use Pixie for application profiling, check out the <a href="/tutorials/pixie-101/profiler/">Profiling with Flamegraphs</a> tutorial.
 </Alert>
 
 ## Related Scripts
diff --git a/content/en/04-tutorials/01-pixie-101/05-request-tracing.md b/content/en/04-tutorials/01-pixie-101/05-request-tracing.md
@@ -36,7 +36,7 @@ If you're interested in troubleshooting HTTP latency, check out the [Service Per
 A developer has noticed that the demo application's `cart` service is reporting errors.
 
 <Alert variant="outlined" severity="info">
-  To see high-level error rates for all of the services in your cluster, check out the <a href="https://docs.px.dev/tutorials/pixie-101/service-performance/#service-graph">Service Graph</a> section of the Service Performance tutorial.
+  To see high-level error rates for all of the services in your cluster, check out the <a href="/tutorials/pixie-101/service-performance/#service-graph">Service Graph</a> section of the Service Performance tutorial.
 </Alert>
 
 Let's use Pixie to look at HTTP requests with specific types of errors:
diff --git a/content/en/04-tutorials/02-pxl-scripts/01-write-pxl-scripts/index.md b/content/en/04-tutorials/02-pxl-scripts/01-write-pxl-scripts/index.md
@@ -30,7 +30,7 @@ This tutorial series demonstrates how to write a PxL script to query data automa
 
 ## Writing PxL Scripts with Visualizations
 
-This tutorial series adds visualizations to the PxL script developed in the [Writing PxL Scripts](/tutorials/pxl-scripts/#writing-pxl-scripts) tutorial series. Pixie's Live UI will be used to execute the script.
+This tutorial series adds visualizations to the PxL script developed in the above [Writing PxL Scripts](/tutorials/pxl-scripts/write-pxl-scripts/#writing-pxl-scripts) tutorial series. Pixie's Live UI will be used to execute the script.
 
 - [Prerequisite #1: Learn how to navigate the Live UI.](/using-pixie/using-live-ui)
 - Prerequisite #2: Setup the script dev environment.
diff --git a/content/en/04-tutorials/03-integrations/02-grafana.md b/content/en/04-tutorials/03-integrations/02-grafana.md
@@ -123,7 +123,7 @@ If you don't see any data in your graph, try:
 
 - Switching to the **Table** visualization to make sure that the query is returning some sort of data in table form.
 
-- Making sure that your cluster has HTTP traffic that Pixie can automatically trace. Instructions for installing a demo application with HTTP traffic can be found [here](https://docs.px.dev/installing-pixie/install-guides/#start-a-demo-app). If you're using your own application, double check that [Pixie supports the protocols](/about-pixie/data-sources) for the traffic in your cluster.
+- Making sure that your cluster has HTTP traffic that Pixie can automatically trace. Instructions for installing a demo application with HTTP traffic can be found [here](/installing-pixie/install-guides/#start-a-demo-app). If you're using your own application, double check that [Pixie supports the protocols](/about-pixie/data-sources) for the traffic in your cluster.
 
 ### Time series graph of HTTP throughput per service
 
diff --git a/content/en/05-reference/01-admin/01-authentication.md b/content/en/05-reference/01-admin/01-authentication.md
@@ -11,7 +11,7 @@ redirect_from:
 
 Pixie uses [Hydra](https://www.ory.sh/hydra/)/[Kratos](https://www.ory.sh/kratos/) to provide an open source authentication flow.
 
-To set up authentication and invite others to join your organization, check out the Quick Start [directions](/installing-pixie/install-guides/self-hosted-pixie/#authentication-using-kratos-hydra).
+To set up authentication and invite others to join your organization, check out the Quick Start [directions](/installing-pixie/install-guides/self-hosted-pixie/#1.-deploy-pixie-cloud-authentication-using-kratos-hydra).
 
 To read about how we designed our open source authentication flow, check out the [blog post](https://blog.px.dev/open-source-auth/ossauth/).
 
diff --git a/content/en/05-reference/01-admin/10-updating-pixie.md b/content/en/05-reference/01-admin/10-updating-pixie.md
@@ -20,7 +20,7 @@ Pixie has three components that can be updated:
 px version
 ```
 
-2. Compare your CLI version with the [latest release](/reference/admin/product-updates/#pixie-cli).
+2. Compare your CLI version with the [latest release](/reference/admin/product-updates/#updating-pixie-cloud-and-vizier-pixie-cli).
 
 3. If necessary, update the CLI with:
 
@@ -39,15 +39,15 @@ Pixie's [CLI tool](/installing-pixie/install-schemes/cli) is required to update
 px get viziers
 ```
 
-2. Compare your Vizier version to the [latest release](/reference/admin/product-updates/#pixie-platform).
+2. Compare your Vizier version to the [latest release](/reference/admin/product-updates/#updating-pixie-cloud-and-vizier-pixie-platform).
 
 3. Update your fork / clone of the [Pixie repo](https://github.com/pixie-io/pixie).
 
 4. (Optional) Update the version numbers in the [`artifact_tracker_versions.yaml` file](https://github.com/pixie-io/pixie/blob/main/k8s/cloud/public/artifact_tracker_versions.yaml). The release versions in this file are periodically updated, but do not track the latest release. To find the latest release, check the release notes:
 
->> - [PL_VIZIER_VERSION](/reference/admin/product-updates/#pixie-platform)
->> - [PL_CLI_VERSION](reference/admin/product-updates/#pixie-cli)
->> - [PL_OPERATOR_VERSION](/reference/admin/product-updates/#pixie-operator)
+>> - [PL_VIZIER_VERSION](/reference/admin/product-updates/#updating-pixie-cloud-and-vizier-pixie-platform)
+>> - [PL_CLI_VERSION](/reference/admin/product-updates/#updating-pixie-cloud-and-vizier-pixie-cli)
+>> - [PL_OPERATOR_VERSION](/reference/admin/product-updates/#updating-pixie-cloud-and-vizier-pixie-operator)
 
 5. Re-deploy Pixie Cloud by running the following . This step assumes you previously deployed Pixie cloud to the default namespace (`plc`).
 
diff --git a/content/en/05-reference/02-architecture.md b/content/en/05-reference/02-architecture.md
@@ -2,27 +2,27 @@
 title: "Architecture"
 metaTitle: "Reference | Architecture"
 metaDescription: "A detailed overview of Pixie's components"
-order: 2 
+order: 2
 ---
 
 ## Overview
 
-Pixie consists of three main components: 
+Pixie consists of three main components:
 
-- **Vizier**: Pixie's data plane for data collection and processing. An instance of Vizier is deployed to each cluster which needs to be monitored. 
+- **Vizier**: Pixie's data plane for data collection and processing. An instance of Vizier is deployed to each cluster which needs to be monitored.
 - **Cloud**: Pixie's control plane for serving Pixie's API and UI, and managing and tracking metadata (e.g. orgs, users, Viziers).
-- **Vizier Operator**: Pixie's [Kubernetes operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) which is used to help deploy and manage Vizier on a cluster, such as keeping all components running and up-to-date. 
+- **Vizier Operator**: Pixie's [Kubernetes operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) which is used to help deploy and manage Vizier on a cluster, such as keeping all components running and up-to-date.
 
 ## Vizier
 
 Vizier is Pixie's data plane. It is responsible for collecting and processing data within the cluster that is being monitored.
 
 ### Components
 
-1. **Pixie Edge Module (PEM)**: The data collectors, deployed to each node via a daemonset. PEMs serve as a short-term in-memory store (up to 24h) for all data collected in the cluster. The PEMs are also responsible for processing this data when they receive a script execution request. 
+1. **Pixie Edge Module (PEM)**: The data collectors, deployed to each node via a daemonset. PEMs serve as a short-term in-memory store (up to 24h) for all data collected in the cluster. The PEMs are also responsible for processing this data when they receive a script execution request.
 2. **Collector (Kelvin)**: Kelvin is the high-level data collector. During script execution, PEMs send partially processed data to Kelvins. Kelvins aggregate the node level view from each PEM into a cluster-level view and complete the script execution steps that requires all of the data, such as aggregates and joins.
 3. **Cloud Connector**: The cloud connector handles message passing between Vizier and Pixie Cloud. These messages range from  heartbeats, used to indicate the Vizier's overall status, and script execution requests and results.
-4. **Metadata**: The metadata service serves as the hub for all of Vizier's metadata. The metadata stored includes k8s objects (ie pods, services, namespaces) for adding context to execute scripts as well as metadata about the Vizier state (ie PEM status, [dynamic logs deployed](https://docs.px.dev/tutorials/custom-data/dynamic-go-logging/)) 
+4. **Metadata**: The metadata service serves as the hub for all of Vizier's metadata. The metadata stored includes k8s objects (ie pods, services, namespaces) for adding context to execute scripts as well as metadata about the Vizier state (ie PEM status, [dynamic logs deployed](/tutorials/custom-data/dynamic-go-logging/))
 5. **Query Broker**: The query broker handles all script execution. It compiles any scripts need to be executed, distributes those scripts to the relevant PEMs, and helps proxy those results back to the cloud.
 
 ### Dependencies
@@ -34,14 +34,14 @@ Vizier relies on a couple of dependencies that are critical to its operation.
 
 ## Cloud
 
-Pixie's cloud components serves as the control plane. The cloud serves Pixie's API and UI to make it easy to query and access data from Viziers. It also manages metadata in the system, such as orgs, users, and Viziers. 
+Pixie's cloud components serves as the control plane. The cloud serves Pixie's API and UI to make it easy to query and access data from Viziers. It also manages metadata in the system, such as orgs, users, and Viziers.
 
 ### Components
 
 1. **Cloud Proxy**: An NGINX and Envoy proxy which serves as the main entrypoint when requests are made to the Cloud. The proxy also hosts the UI.
 2. **API**: The API service serves as a proxy for any incoming API requests (GQL, GRPC, Python, Go), and redirects the request to the relevant downstream services in the Cloud.
 3. **Auth**: The Auth service is responsible for handling authentication/authorization for ensuring that any tokens/cookies/API keys are valid before servicing a request.
-4. **Vizier Connector (VZConn)**: VZConn serves as the communication point between Cloud and all connected Viziers. It proxies data between the Vizier and the relevant downstream services in the Cloud. 
+4. **Vizier Connector (VZConn)**: VZConn serves as the communication point between Cloud and all connected Viziers. It proxies data between the Vizier and the relevant downstream services in the Cloud.
 5. **Vizier Manager (VZMgr)**: VZMgr tracks and manages the state of all connected Viziers, such as the version or current health of a Vizier.
 6. **Artifact Tracker**: The artifact tracker manages version and release information for all Pixie-related artifacts, such as the Vizier and CLI. For example, it can be queried to obtain the necessary download links for a Vizier's base deployment YAMLs.
 7. **Config Manager**: The config manager is responsible for customizing a Vizier's deployment YAMLs based on an user's/org's specified deployment options.
@@ -59,6 +59,6 @@ Pixie's cloud components serves as the control plane. The cloud serves Pixie's A
 
 The Vizier Operator is used to help manage Vizier on a cluster. The operator executes the initial deploy of Vizier, deciding which Vizier configurations are best fit for an environment (if not already specified), and monitors the overall state of the Vizier. This includes restarting any failed dependencies and keeping Vizier up-to-date, based on the latest release information from Pixie Cloud.
 
-### Dependencies 
+### Dependencies
 
 1. **[Operator Lifecycle Manager](https://olm.operatorframework.io/)**: OLM is responsible for deploying the Vizier Operator to a cluster and keeping the Vizier Operator up-to-date.
diff --git a/content/en/05-reference/04-plugins/02-grafana.md b/content/en/05-reference/04-plugins/02-grafana.md
@@ -2,7 +2,7 @@
 title: "Grafana Datasource Plugin"
 metaTitle: "Reference | Plugins | Grafana Datasource Plugin "
 metaDescription: "Pixie's Grafana Datasource Plugin"
-order: 2 
+order: 2
 ---
 
 The Pixie Datasource plugin allows you to visualize data from the Pixie observability platform in Grafana.
