Skip to content

Commit 815bf75

Browse files
committed
Fix relative link confusion.
Signed-off-by: Thomas Hallgren <thomas@tada.se>
1 parent c0f571b commit 815bf75

File tree

12 files changed

+19
-40
lines changed

12 files changed

+19
-40
lines changed

.github/workflows/lint.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ jobs:
1010
- name: "yarn run gatsby build"
1111
run: |
1212
# The sed part of this command removes terminal escape codes.
13-
NODE_ENV=development yarn run gatsby build 2> >(tee /dev/stdout | sed $'s/\e[^a-z]*[a-z]//g' > err.log)
14-
- run: |
15-
! grep ^ err.log
13+
NODE_ENV=development yarn run gatsby build
1614
- name: "Dirty check"
1715
run: |
1816
git add .

docs/v2.19/doc-links.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
- title: Install Telepresence
44
items:
55
- title: Install Client
6-
link: install/
6+
link: install/client/
77
- title: Upgrade Client
88
link: install/upgrade/
99
- title: Install Traffic Manager

docs/v2.19/howtos/intercepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Telepresence enables you to create intercepts to a target Kubernetes workload. O
1212

1313
## Prerequisites
1414

15-
Before you begin, you need to have [Telepresence installed](../install), and either the Kubernetes command-line tool, [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/), or the OpenShift Container Platform command-line interface, [`oc`](https://docs.openshift.com/container-platform/4.2/cli_reference/openshift_cli/getting-started-cli.html#cli-installing-cli_cli-developer-commands). This document uses kubectl in all example commands. OpenShift users can substitute oc [commands instead](https://docs.openshift.com/container-platform/4.1/cli_reference/developer-cli-commands.html).
15+
Before you begin, you need to have [Telepresence installed](../install/client), and either the Kubernetes command-line tool, [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/), or the OpenShift Container Platform command-line interface, [`oc`](https://docs.openshift.com/container-platform/4.2/cli_reference/openshift_cli/getting-started-cli.html#cli-installing-cli_cli-developer-commands). This document uses kubectl in all example commands. OpenShift users can substitute oc [commands instead](https://docs.openshift.com/container-platform/4.1/cli_reference/developer-cli-commands.html).
1616

1717
This guide assumes you have a Kubernetes deployment and service accessible publicly by an ingress controller, and that you can run a copy of that service on your laptop.
1818

File renamed without changes.

docs/v2.19/install/manager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Telepresence uses a traffic manager to send/recieve cloud traffic to the user. T
44

55
## Prerequisites
66

7-
Before you begin, you need to have [Telepresence installed](../install/).
7+
Before you begin, you need to have [Telepresence installed](../install/client).
88

99
If you are not the administrator of your cluster, you will need [administrative RBAC permissions](../reference/rbac#administrating-telepresence) to install and use Telepresence in your cluster.
1010

docs/v2.19/quick-start/index.md renamed to docs/v2.19/quick-start.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ Telepresence is an open source tool that enables you to set up remote developmen
1616

1717
## Install Telepresence
1818

19-
Follow [Install Client](../install) and [Install Traffic Manager](../install/manager) instructions to install the
19+
Follow [Install Client](install/client) and [Install Traffic Manager](install/manager) instructions to install the
2020
telepresence client on your workstation, and the traffic manager in your cluster.
2121

2222
## Intercept Your Service
2323

24-
With Telepresence, you can create [intercepts](../concepts/intercepts?intercept=global) that intercept all traffic going to a service in your remote cluster and route it to your local environment instead.
24+
With Telepresence, you can create [intercepts](concepts/intercepts?intercept=global) that intercept all traffic going to a service in your remote cluster and route it to your local environment instead.
2525

2626
1. Connect to your cluster with `telepresence connect` and connect to the Kubernetes API server:
2727

@@ -117,6 +117,6 @@ Now, with Telepresence, you can:
117117
</Alert>
118118

119119
## What’s Next?
120-
- [Learn about the Telepresence architecture.](../reference/architecture)
120+
- [Learn about the Telepresence architecture.](reference/architecture)
121121

122122
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=d842651a-2e4d-465a-98e1-4808722c01ab" />

docs/v2.19/reference/cluster-config.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import Alert from '@material-ui/lab/Alert';
2-
import { ClusterConfig } from '@src/components/Docs/Telepresence';
32

43
# Cluster-side configuration
54

docs/v2.19/troubleshooting/index.md renamed to docs/v2.19/troubleshooting.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ description: "Learn how to troubleshoot common issues related to Telepresence, i
66

77
## Connecting to a cluster via VPN doesn't work.
88

9-
There are a few different issues that could arise when working with a VPN. Please see the [dedicated page](../reference/vpn) on Telepresence and VPNs to learn more on how to fix these.
9+
There are a few different issues that could arise when working with a VPN. Please see the [dedicated page](reference/vpn) on Telepresence and VPNs to learn more on how to fix these.
1010

1111
## Connecting to a cluster hosted in a VM on the workstation doesn't work
1212

1313
The cluster probably has access to the host's network and gets confused when it is mapped by Telepresence.
14-
Please check the [cluster in hosted vm](../howtos/cluster-in-vm) for more details.
14+
Please check the [cluster in hosted vm](howtos/cluster-in-vm) for more details.
1515

1616
## Volume mounts are not working on macOS
1717

@@ -76,7 +76,7 @@ $ telepresence upload-traces traces.gz $OTLP_GRPC_ENDPOINT
7676

7777
Once that's been done, the traces will be visible via whatever means your usual collector allows. For example, this is what they look like when loaded into Jaeger's [OTLP API](https://www.jaegertracing.io/docs/1.36/apis/#opentelemetry-protocol-stable):
7878

79-
![Jaeger Interface](../images/tracing.png)
79+
![Jaeger Interface](images/tracing.png)
8080

8181
**Note:** The host and port provided for the `OTLP_GRPC_ENDPOINT` must accept OTLP formatted spans (instead of e.g. Jaeger or Zipkin specific spans) via a GRPC API (instead of the HTTP API that is also available in some collectors)
8282
**Note:** Since traces are not automatically shipped to the backend by telepresence, they are stored in memory. Hence, to avoid running telepresence components out of memory, only the last 10MB of trace data are available for export.
@@ -104,7 +104,7 @@ Traffic Manager's webhook injector from the API server.
104104
To fix this, add a firewall rule allowing your cluster's master nodes to access TCP port `443` in your cluster's pods,
105105
or change the port number that Telepresence is using for the agent injector by providing the number of an allowed port
106106
using the Helm chart value `agentInjector.webhook.port`.
107-
Please refer to the [telepresence install instructions](../install/cloud#gke) or the [GCP docs](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#add_firewall_rules) for information to resolve this.
107+
Please refer to the [telepresence install instructions](install/cloud#gke) or the [GCP docs](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#add_firewall_rules) for information to resolve this.
108108

109109
## Injected init-container doesn't function properly
110110

@@ -156,7 +156,7 @@ not get remapped. A headless service will always require the init-container.
156156
## Error connecting to GKE or EKS cluster
157157

158158
GKE and EKS require a plugin that utilizes their resepective IAM providers.
159-
You will need to install the [gke](../install/cloud#gke-authentication-plugin) or [eks](../install/cloud#eks-authentication-plugin) plugins
159+
You will need to install the [gke](install/cloud#gke-authentication-plugin) or [eks](install/cloud#eks-authentication-plugin) plugins
160160
for Telepresence to connect to your cluster.
161161

162162
## `too many files open` error when running `telepresence connect` on Linux

src/components/Docs/Telepresence/ClusterConfig.js

Lines changed: 0 additions & 23 deletions
This file was deleted.

src/components/Docs/Telepresence/index.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)