Skip to content

Commit f91a8c1

Browse files
docs: add extra ../ to all local refs (#132)
Signed-off-by: Arnob Kumar Saha <arnob@appscode.com>
1 parent 8303130 commit f91a8c1

62 files changed

Lines changed: 410 additions & 420 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/ci.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jobs:
2828
2929
- name: Install link checker
3030
run: |
31-
curl -fsSL -o liche https://github.com/appscodelabs/liche/releases/download/v0.1.0/liche-linux-amd64
31+
curl -fsSL -o liche https://github.com/appscodelabs/liche/releases/download/v0.2.0/liche-linux-amd64
3232
chmod +x liche
3333
sudo mv liche /usr/local/bin/liche
3434
@@ -50,11 +50,11 @@ jobs:
5050
5151
- name: Check links
5252
run: |
53-
liche -r docs -d $(pwd) -c 10 -p -h -l -x '^(.*golang.org.*|.*github.com.*|.*api.slack.com.*|.*twitter.com.*|.*linode.com.*|.*helm.sh.*|.*k8s.io.*|.*percona.com.*|.*kubernetes.io.*|.*search-guard.com.*|.*hub.docker.com.*|.*appscode.com.*|.*mongodb.com.*|.*community.arm.com.*|.*cluster.com.*|.*proxysql.com.*|.*postgresql.org.*|.*kafka.com.*|.*stackoverflow.com.*|.*redis.io.*|.*elastic.co.*|.*mysql.*|.*developer.hashicorp.com.*|.*pgpool.net.*|.*clickhouse.com.*)$'
53+
liche -r docs -d $(pwd) -c 10 -p -h -l -s -x '^(.*golang.org.*|.*github.com.*|.*api.slack.com.*|.*twitter.com.*|.*linode.com.*|.*helm.sh.*|.*k8s.io.*|.*percona.com.*|.*kubernetes.io.*|.*search-guard.com.*|.*hub.docker.com.*|.*appscode.com.*|.*mongodb.com.*|.*community.arm.com.*|.*cluster.com.*|.*proxysql.com.*|.*postgresql.org.*|.*kafka.com.*|.*stackoverflow.com.*|.*redis.io.*|.*elastic.co.*|.*mysql.*|.*developer.hashicorp.com.*|.*pgpool.net.*|.*clickhouse.com.*)$'
5454
max_retries=5
5555
retry_count=0
5656
while [ $retry_count -lt $max_retries ]; do
57-
if liche -r docs -d $(pwd) -c 10 -p -h -l -x '^(.*golang.org.*|.*github.com.*|.*api.slack.com.*|.*twitter.com.*|.*linode.com.*|.*helm.sh.*|.*k8s.io.*|.*percona.com.*|.*kubernetes.io.*|.*search-guard.com.*|.*hub.docker.com.*|.*appscode.com.*|.*mongodb.com.*|.*community.arm.com.*|.*cluster.com.*|.*proxysql.com.*|.*postgresql.org.*|.*kafka.com.*|.*stackoverflow.com.*|.*redis.io.*|.*elastic.co.*|.*mysql.*|.*developer.hashicorp.com.*|.*pgpool.net.*|.*clickhouse.com.*)$'; then
57+
if liche -r docs -d $(pwd) -c 10 -p -h -l -s -x '^(.*golang.org.*|.*github.com.*|.*api.slack.com.*|.*twitter.com.*|.*linode.com.*|.*helm.sh.*|.*k8s.io.*|.*percona.com.*|.*kubernetes.io.*|.*search-guard.com.*|.*hub.docker.com.*|.*appscode.com.*|.*mongodb.com.*|.*community.arm.com.*|.*cluster.com.*|.*proxysql.com.*|.*postgresql.org.*|.*kafka.com.*|.*stackoverflow.com.*|.*redis.io.*|.*elastic.co.*|.*mysql.*|.*developer.hashicorp.com.*|.*pgpool.net.*|.*clickhouse.com.*)$'; then
5858
echo "Link check passed"
5959
exit 0
6060
fi

docs/platform/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ This page is the entry point for KubeDB Platform documentation.
2121

2222
## Core sections
2323

24-
- [Selfhost Setup](./selfhost-setup/)
25-
- [Guides](./guides/)
24+
- [Selfhost Setup](../selfhost-setup/)
25+
- [Guides](../guides/)
2626

2727
## Contributor resources
2828

29-
- [Contributing](./contributing.md)
30-
- [Support](./support.md)
29+
- [Contributing](../contributing.md)
30+
- [Support](../support.md)
3131

32-
Use [Guides](./guides/) for day-to-day workflows, then continue to [Selfhost Setup](./selfhost-setup/) for deployment-specific instructions.
32+
Use [Guides](../guides/) for day-to-day workflows, then continue to [Selfhost Setup](../selfhost-setup/) for deployment-specific instructions.

docs/platform/guides/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ This section contains practical, task-oriented guides for operating and managing
1919

2020
## Guide categories
2121

22-
- [Account Management](./account-management/)
23-
- [Billing and Usage Guide](./billing-and-usage-guide/)
24-
- [Cluster Management](./cluster-management/)
25-
- [Database Management](./database-management/)
26-
- [Get Started](./get-started/)
27-
- [Integrations](./integrations/)
28-
- [License Management](./license-management/)
22+
- [Account Management](../account-management/)
23+
- [Billing and Usage Guide](../billing-and-usage-guide/)
24+
- [Cluster Management](../cluster-management/)
25+
- [Database Management](../database-management/)
26+
- [Get Started](../get-started/)
27+
- [Integrations](../integrations/)
28+
- [License Management](../license-management/)
2929

3030
## Recommended path
3131

32-
For first-time users, start with [Get Started](./get-started/) and then move to the specific management areas relevant to your workflow.
32+
For first-time users, start with [Get Started](../get-started/) and then move to the specific management areas relevant to your workflow.

docs/platform/guides/account-management/site-administration/client-org.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ A Client Organization provides logical separation between different clients shar
2121

2222
Before creating a Client Organization, make sure the following are already in place:
2323

24-
- **A Hub cluster is set up** — See [Create Hub & Spoke](../../cluster-management/hub-ui/create.md) for the full setup guide.
24+
- **A Hub cluster is set up** — See [Create Hub & Spoke](../../../cluster-management/hub-ui/create.md) for the full setup guide.
2525
- **A Spoke cluster is connected to the Hub** — The Spoke must be linked and accepted by the Hub administrator.
26-
- **The Spoke cluster is licensed** — A valid license certificate must be applied to the Spoke. Without it, database features remain in a **Warning** state and the organization cannot be created. See [License Management](../../cluster-management/hub-ui/license-management.md) for details.
26+
- **The Spoke cluster is licensed** — A valid license certificate must be applied to the Spoke. Without it, database features remain in a **Warning** state and the organization cannot be created. See [License Management](../../../cluster-management/hub-ui/license-management.md) for details.
2727

2828
> ⚠️ Always perform these steps from an **Organization/Work account**. Personal accounts do not support Hub-Spoke features.
2929

docs/platform/guides/billing-and-usage-guide/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ What you’ll see in the Billable table
5454
- Usage covered by the **30‑day free contract** when there’s no paid contract for the selected product.
5555

5656
**How to influence these numbers:**
57-
- Cluster mode (`PROD` vs `NON‑PROD`) and namespace trials are configured in Cost Management: [Cost Management](./cost-management.md)
57+
- Cluster mode (`PROD` vs `NON‑PROD`) and namespace trials are configured in Cost Management: [Cost Management](../cost-management.md)
5858
- Contract behavior (`paid` vs. `30‑day free` when none exists) is described here: [Contract docs](http://appscode.com/docs/en/guides/license-management/contract.html)
5959

6060
**For more details, please contact** [AppsCode administrators](https://appscode.com/contact/).

docs/platform/guides/client-organization/add-cluster-to-existing-client-organization.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,40 +12,40 @@ section_menu_id: guides
1212

1313
# Add a Cluster to an Existing Client Organization
1414

15-
You can assign additional clusters to a client organization after it has been created. The **Add Cluster** wizard reuses the same **Gateway Configuration** and **Telemetry Configuration** steps as the [Create Client Organization](./create-client-organization.md) wizard.
15+
You can assign additional clusters to a client organization after it has been created. The **Add Cluster** wizard reuses the same **Gateway Configuration** and **Telemetry Configuration** steps as the [Create Client Organization](../create-client-organization.md) wizard.
1616

1717
## Open the Client Organization
1818

1919
Go to **Site Administration → Client Organizations** and click the organization's **Name** in the list to open its details.
2020

21-
![Client Organizations list — click an organization's name to open its details](./images/client-org-overview.png)
21+
![Client Organizations list — click an organization's name to open its details](.././images/client-org-overview.png)
2222

2323
## Find the Add Cluster option
2424

2525
On the organization's details page, the **Clusters** section lists the clusters already assigned to the organization. Click **Add Cluster** in the top-right of that section to start the wizard.
2626

27-
![Client organization details page — the Clusters section with the Add Cluster button](./images/client-org-details.png)
27+
![Client organization details page — the Clusters section with the Add Cluster button](.././images/client-org-details.png)
2828

2929
## Step 1: Select Cluster
3030

3131
In the first step of the **Add Cluster** wizard, choose the cluster to assign and optionally tune where its database workloads are scheduled.
3232

33-
![Add Cluster wizard — Select Cluster step with hub cluster, spoke cluster, and DB nodepool](./images/add-cluster-to-existing-client-org.png)
33+
![Add Cluster wizard — Select Cluster step with hub cluster, spoke cluster, and DB nodepool](.././images/add-cluster-to-existing-client-org.png)
3434

3535
- **Hub Cluster** *(required)* — the management (hub) cluster for this assignment.
3636
- **Spoke Cluster** *(required)* — the spoke cluster where the organization's databases run.
3737
- **Configure DB Nodepool** *(optional)* — key/value labels used to target specific nodes for database workloads.
3838
- **Tolerations** *(optional)* — add tolerations so workloads can be scheduled onto tainted nodes. Each toleration takes an **Effect**, **Key**, **Operator**, and **Value**.
3939

40-
![Add Cluster wizard — Select Cluster step with DB nodepool and tolerations expanded](./images/add-cluster-to-existing-client-org-2.png)
40+
![Add Cluster wizard — Select Cluster step with DB nodepool and tolerations expanded](.././images/add-cluster-to-existing-client-org-2.png)
4141

4242
Click **Next** to continue.
4343

4444
## Remaining Steps
4545

4646
After selecting the cluster, the wizard continues with the same **Gateway Configuration** and **Telemetry Configuration** steps used when creating a client organization:
4747

48-
- [Gateway Configuration](./create-client-organization.md#step-3-gateway-configuration) — choose a shared or dedicated gateway.
49-
- [Telemetry Configuration](./create-client-organization.md#step-4-telemetry-configuration) — configure log and metrics retention.
48+
- [Gateway Configuration](../create-client-organization.md#step-3-gateway-configuration) — choose a shared or dedicated gateway.
49+
- [Telemetry Configuration](../create-client-organization.md#step-4-telemetry-configuration) — configure log and metrics retention.
5050

5151
Configure them as needed, then finish to add the cluster to the organization. The new cluster then appears in the **Clusters** section of the organization's details page.

docs/platform/guides/client-organization/create-client-organization.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The wizard has four steps, shown on the right side of the form:
2525

2626
Enter the organization details and choose its administrator.
2727

28-
![Create Client Organization wizard — Step 1, User Information form with organization name, custom annotations, organization admin, and visibility](./images/create-client-organization.png)
28+
![Create Client Organization wizard — Step 1, User Information form with organization name, custom annotations, organization admin, and visibility](.././images/create-client-organization.png)
2929

3030
- **Organization Name** *(required)* — used to provision the three namespaces (`orgName`, `orgName-gw`, and `orgName-monitoring`).
3131
- **Organization Display Name** — a friendly name shown in the UI.
@@ -42,7 +42,7 @@ Click **Next** to continue.
4242

4343
Assign the organization to a hub and spoke cluster, and optionally tune where its database workloads are scheduled.
4444

45-
![Create Client Organization wizard — Step 2, Select Cluster with hub cluster, spoke cluster, DB nodepool, and tolerations](./images/create-client-organization-2.png)
45+
![Create Client Organization wizard — Step 2, Select Cluster with hub cluster, spoke cluster, DB nodepool, and tolerations](.././images/create-client-organization-2.png)
4646

4747
- **Hub Cluster** *(required)* — the management (hub) cluster for this organization.
4848
- **Spoke Cluster** *(required)* — the spoke cluster where the organization's databases run.
@@ -59,39 +59,39 @@ Choose how the organization exposes its workloads. There are two top-level optio
5959

6060
Select **Use Shared Gateway** to reuse the platform's shared gateway. No additional gateway configuration is required.
6161

62-
![Create Client Organization wizard — Step 3, Use Shared Gateway selected with no extra configuration](./images/use-shared-gateway.png)
62+
![Create Client Organization wizard — Step 3, Use Shared Gateway selected with no extra configuration](.././images/use-shared-gateway.png)
6363

6464
### Use Dedicated Gateway
6565

6666
Select **Use Dedicated Gateway** to give the organization its own gateway. Then pick a **Dedicated Gateway Type**.
6767

68-
![Create Client Organization wizard — Step 3, Use Dedicated Gateway selected with the dedicated gateway type options](./images/use-dedicated-gateway.png)
68+
![Create Client Organization wizard — Step 3, Use Dedicated Gateway selected with the dedicated gateway type options](.././images/use-dedicated-gateway.png)
6969

7070
#### Use Existing Gateway
7171

7272
Choose **Use Existing Gateway** and select a **Gateway Preset Config** to reuse an already-defined gateway configuration.
7373

74-
![Create Client Organization wizard — dedicated gateway using an existing gateway preset config](./images/use-existing-gateway.png)
74+
![Create Client Organization wizard — dedicated gateway using an existing gateway preset config](.././images/use-existing-gateway.png)
7575

7676
#### Use Custom Gateway
7777

7878
Choose **Use Custom Gateway** to define the gateway yourself. Use **Can it be used as a shared Gateway?** to pick a starting point.
7979

8080
**Preload From Existing One** — start from an existing **Gateway Preset Config**, then edit the pre-filled fields across the **In Cluster** (certificates and keys), **Envoy Service** (service type, external IP, traffic policy, ports, provisioner type), and **Infra** (DNS provider, host type, host/domain, TLS issuer) sections.
8181

82-
![Create Client Organization wizard — custom dedicated gateway preloaded from an existing preset, showing In Cluster, Envoy Service, and Infra sections](./images/preload-existing-gateway.png)
82+
![Create Client Organization wizard — custom dedicated gateway preloaded from an existing preset, showing In Cluster, Envoy Service, and Infra sections](.././images/preload-existing-gateway.png)
8383

8484
**Create New From Start** — build the gateway from scratch by filling in the same **In Cluster**, **Envoy Service**, and **Infra** sections with your own values.
8585

86-
![Create Client Organization wizard — custom dedicated gateway created from scratch with empty In Cluster, Envoy Service, and Infra sections](./images/create-new-custom-gateway.png)
86+
![Create Client Organization wizard — custom dedicated gateway created from scratch with empty In Cluster, Envoy Service, and Infra sections](.././images/create-new-custom-gateway.png)
8787

8888
Click **Next** to continue.
8989

9090
## Step 4: Telemetry Configuration
9191

9292
In the final step, configure the telemetry settings that will be applied to the organization's `orgName-monitoring` namespace, then finish to create the client organization.
9393

94-
![Create Client Organization wizard — Step 4, Telemetry Configuration with monitoring type, log retention, and metrics retention periods](./images/telemetry-configuration.png)
94+
![Create Client Organization wizard — Step 4, Telemetry Configuration with monitoring type, log retention, and metrics retention periods](.././images/telemetry-configuration.png)
9595

9696
- **Select Monitoring Type** — choose the monitoring stack to provision for the organization.
9797
- **Logs** — set the **Retention Period** for collected logs.
@@ -106,4 +106,4 @@ Once created, the organization appears in the **Client Organizations** list and
106106

107107
## Next steps
108108

109-
- [Add a Cluster to an Existing Client Organization](./add-cluster-to-existing-client-organization.md) — assign additional clusters after the organization is created.
109+
- [Add a Cluster to an Existing Client Organization](../add-cluster-to-existing-client-organization.md) — assign additional clusters after the organization is created.

docs/platform/guides/client-organization/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,5 +35,5 @@ Client organizations are managed from **Site Administration → Client Organizat
3535

3636
## Next steps
3737

38-
- [Create a Client Organization](./create-client-organization.md) — a step-by-step walkthrough of the creation wizard.
39-
- [Add a Cluster to an Existing Client Organization](./add-cluster-to-existing-client-organization.md) — assign additional clusters after the organization is created.
38+
- [Create a Client Organization](../create-client-organization.md) — a step-by-step walkthrough of the creation wizard.
39+
- [Add a Cluster to an Existing Client Organization](../add-cluster-to-existing-client-organization.md) — assign additional clusters after the organization is created.

docs/platform/guides/cluster-management/add-cluster/create-vendor-managed.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ section_menu_id: guides
1313

1414
# Create Vendor Managed Clusters
1515

16-
![Create vendor-managed cluster form showing cluster name, region, machine type, and cluster profile selection](../images/add_cluster/create-cluster-form.png)
16+
![Create vendor-managed cluster form showing cluster name, region, machine type, and cluster profile selection](../../images/add_cluster/create-cluster-form.png)
1717

18-
![Creating cluster progress modal showing live status log](../images/add_cluster/create-cluster-progress.png)
18+
![Creating cluster progress modal showing live status log](../../images/add_cluster/create-cluster-progress.png)

docs/platform/guides/cluster-management/add-cluster/import-rancher-cluster.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ Importing a `Rancher-Managed` cluster requires a Rancher Type Credential and a R
1717

1818
## Create Rancher Type Credential
1919

20-
Add a credential of type "Rancher" — see [Credentials Management](../../account-management/kubernetes/credentials.md#rancher).
20+
Add a credential of type "Rancher" — see [Credentials Management](../../../account-management/kubernetes/credentials.md#rancher).
2121

2222
## Create a Rancher Managed Organization
2323

24-
Rancher clusters belong to Rancher Managed organizations, not personal accounts. Follow [Create a New Organization](../../account-management/orgs-members.md#create-a-new-organization) with these settings:
24+
Rancher clusters belong to Rancher Managed organizations, not personal accounts. Follow [Create a New Organization](../../../account-management/orgs-members.md#create-a-new-organization) with these settings:
2525

2626
1. Set the organization's Origin to `Rancher Managed`.
2727
2. Provide the Rancher `API Endpoint` (found on the `Account & API Keys` page).
@@ -30,4 +30,4 @@ Rancher clusters belong to Rancher Managed organizations, not personal accounts.
3030
## Import the Cluster
3131

3232
1. Switch to the Rancher organization: in the [AppsCode Console](https://console.appscode.com), click your profile, choose `Switch Account`, and select the Rancher organization.
33-
2. Follow the standard import process in [Import Vendor Managed Clusters](import-vendor-managed.md).
33+
2. Follow the standard import process in [Import Vendor Managed Clusters](../import-vendor-managed.md).

0 commit comments

Comments
 (0)