Skip to content

Commit 3605db6

Browse files
authored
use hugo ref for linking (#362)
Signed-off-by: Etai Lev Ran <elevran@gmail.com>
1 parent 2ac8493 commit 3605db6

File tree

7 files changed

+19
-19
lines changed

7 files changed

+19
-19
lines changed

website/content/en/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ title: ClusterLink
88

99
{{< /blocks/cover >}}
1010

11-
1211
{{% blocks/lead color="primary" height="auto" %}}
1312

1413
{{% clusterlink/main %}}ClusterLink simplifies the connection between application services that are located in different domains, networks, and cloud infrastructures.{{% /clusterlink/main %}}

website/content/en/about/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ ClusterLink is in **alpha** status and not ready for production use.
1313
{{% /pageinfo %}}
1414
ClusterLink is a secure interconnectivity solution for working across the multi-cloud. It simplifies the connection between application services that are located in different domains, networks, and cloud infrastructures.
1515

16-
### The main usage scenarios
16+
## The main usage scenarios
1717

1818
* Efficiently connecting services across multiple cloud clusters
1919
* Providing seamless application-centric connectivity across existing private networks
2020

21-
### Core features
21+
## Core features
2222

2323
* Ensures global presence and availability
2424
* Avoids vendor lock-in

website/content/en/docs/concepts/fabric.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ description: Defining a ClusterLink fabric
44
weight: 32
55
---
66

7-
The concept of a `Fabric` encapsulates a set of cooperating [sites](/docs/concepts/sites/).
8-
All sites in a fabric can communicate and may share [services](/docs/concepts/services)
9-
between them, with access governed by [policies](/docs/concepts/policies/).
7+
The concept of a `Fabric` encapsulates a set of cooperating [sites]({{< ref "sites" >}}/).
8+
All sites in a fabric can communicate and may share [services]({{< ref "services" >}})
9+
between them, with access governed by [policies]({{< ref "policies" >}}).
1010
The `Fabric` acts as a root of trust for site to site communications (i.e.,
1111
it functions as the certificate authority enabling mutual authentication between
1212
sites).
@@ -43,5 +43,5 @@ This command will create the CA files `<fabric_name>.cert` and `<fabric_name>.ke
4343
## Related tasks
4444

4545
Once a `Fabric` has been created and initialized, you can proceed with configuring
46-
[sites](/docs/concepts/sites/). For a complete, end to end, use case please refer to the
47-
[iperf toturial](/docs/tutorials/iperf/).
46+
[sites]({{< ref "sites" >}}). For a complete, end to end, use case please refer to the
47+
[iperf toturial]({{< ref "iperf" >}}).

website/content/en/docs/concepts/sites.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ weight: 34
55
---
66

77
A `Site` represents a location, such as a Kubernetes cluster, participating in a
8-
[Fabric](/docs/concepts/fabric/). Each site may host one or more [Services](/docs/concepts/services/)
8+
[Fabric]({{< ref "fabric" >}}). Each site may host one or more [Services]({{< ref "services" >}})
99
it wishes to share with other sites. A site is managed by a site administrator,
1010
which is responsible for running the ClusterLink control and data planes. The
1111
administrator will typically deploy the ClusterLink components by configuring
12-
the [deployment CRD](/docs/getting-started/#setup). They may also wish to provide
12+
the [deployment CRD]({{< ref "getting-started#setup" >}}). They may also wish to provide
1313
(often) coarse-grained access policies in accordance with high level corporate
1414
policies (e.g., "production sites should only communicate with other production sites").
1515

@@ -25,7 +25,7 @@ Once a `Site` has been added to a `Fabric`, it can communicate with any other `S
2525
The following assume that you have access to the `clusterlink` CLI and one or more
2626
sites (i.e., clusters) where you'll deploy ClusterLink. The CLI can be downloaded
2727
from the ClusterLink [releases page on GitHub](https://github.com/clusterlink-net/clusterlink/releases/latest).
28-
It also assumes that you have access to the [previously created](/docs/concepts/fabric/#create-a-new-fabric-ca)
28+
It also assumes that you have access to the [previously created]({{< ref "fabric#create-a-new-fabric-ca" >}})
2929
Fabric CA files.
3030

3131
### Create a new Site certificate
@@ -90,12 +90,12 @@ This operation is typically done by a local *Site administrator*, typically diff
9090

9191
After the operator is installed, you can deploy ClusterLink by applying
9292
the ClusterLink instance CRD.
93-
Refer to the [getting started guide](/docs/getting-started/#setup) for a description
93+
Refer to the [getting started guide]({{< ref "getting-started#setup" >}}) for a description
9494
of the CRD instance fields.
9595

9696
## Related tasks
9797

9898
Once a `Site` has been created and initialized with the ClusterLink control and data
99-
planes, you can proceed with configuring [services](/docs/concepts/services/)
100-
and [policies](/docs/concepts/policies/).
101-
For a complete end to end use case, refer to [iperf toturial](/docs/tutorials/iperf/).
99+
planes, you can proceed with configuring [services]({{< ref "services" >}})
100+
and [policies]({{< ref "policies" >}}).
101+
For a complete end to end use case, refer to [iperf toturial]({{< ref "iperf" >}}).

website/content/en/docs/doc-contribution/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ If you want to run your own local Hugo server to preview your changes as you wor
5858

5959
<!-- TODO should add a dedicated getting-started for website authoring -->
6060

61-
1. Follow the instructions in [Getting started](/docs/getting-started) to install Hugo
61+
1. Follow the instructions in [Getting started]({{< ref "getting-started" >}}) to install Hugo
6262
and any other tools you need. You'll need at least **Hugo version 0.110** (we recommend
6363
using the most recent available version), and it must be the **extended** version,
6464
which supports SCSS.

website/content/en/docs/getting-started/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,4 @@ To deploy ClusterLink on another cluster, please repeat steps 2-4 in the console
9898
9999
## Try it out
100100
101-
Check out the [ClusterLink Tutorials](../../docs/tutorials/) for setting up multi-cluster connectivity for applications using two or more clusters.
101+
Check out the [ClusterLink Tutorials]({{< ref "tutorials" >}}) for setting up multi-cluster connectivity for applications using two or more clusters.

website/content/en/docs/overview/_index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,6 @@ The distributed control plane and the fine grained connection establishment cont
4545

4646
## Where should I go next?
4747

48-
* [Getting Started](/docs/getting-started/): Get started with ClusterLink
49-
* [Tutorials](/docs/tutorials/): Check out some examples and step-by-step instructions for different use cases.
48+
* [Getting Started]({{< ref "getting-started" >}}): Get started with ClusterLink
49+
* [Tutorials]({{< ref "tutorials" >}}): Check out some examples and step-by-step
50+
instructions for different use cases.

0 commit comments

Comments
 (0)