Skip to content

Commit 2be2631

Browse files
docs: fix broken welcome/guides/selfhost-setup pages (README.md vs _index.md collision) (#137)
Signed-off-by: Arnob kumar saha <arnob@appscode.com>
1 parent 94d69e3 commit 2be2631

6 files changed

Lines changed: 82 additions & 13 deletions

File tree

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ jobs:
5151
5252
- name: Check links
5353
run: |
54-
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.*|.*portal.azure.com.*|.*vultr.com.*)$'
54+
liche -r docs -d $(pwd) -c 10 -p -h -l -s -i '^README\.md$' -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.*|.*portal.azure.com.*|.*vultr.com.*)$'
5555
max_retries=5
5656
retry_count=0
5757
while [ $retry_count -lt $max_retries ]; do
58-
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.*|.*portal.azure.com.*|.*vultr.com.*)$'; then
58+
if liche -r docs -d $(pwd) -c 10 -p -h -l -s -i '^README\.md$' -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.*|.*portal.azure.com.*|.*vultr.com.*)$'; then
5959
echo "Link check passed"
6060
exit 0
6161
fi

CLAUDE.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Docs repo notes
2+
3+
Migrated from VitePress to Hugo (`98965f8`). Content lives under `docs/platform/`.
4+
5+
## The extra `../` convention (intentional, do not "fix")
6+
7+
Every relative link/image in this repo needs **one extra `../`** beyond what the
8+
real filesystem nesting implies — this applies uniformly to `_index.md` section
9+
pages AND regular leaf `.md` pages, even for files in the *same* directory
10+
(e.g. `cluster-overview.md` links to its sibling `images/` dir as `../images/...`).
11+
This is real, required Hugo behavior on the live site — verified by checking
12+
which files actually 404 vs render. Don't "correct" it back to matching disk
13+
paths; that breaks the live site even though it looks more "correct".
14+
15+
Plain file links keep the `.md` extension (e.g. `../mongodb.md`) — this is fine,
16+
Hugo resolves it. Only anchor links were converted from `.md#anchor` to `/#anchor`
17+
form (`#134`), because `.md#anchor` doesn't resolve but `.md` alone does.
18+
19+
## liche (CI link checker)
20+
21+
CI uses a custom fork (`appscodelabs/liche`, branch `arnob-strip-prefix`) with
22+
extra flags: `-s, --strip-relative-prefix` — strips one leading `../` from
23+
each relative link before checking it against the filesystem. This exists
24+
*because* of the extra-`../` convention above: it lets the checker validate
25+
against real on-disk paths without every link failing.
26+
27+
`-i, --skip-filename <regex>` excludes files by base name from being scanned
28+
entirely — CI passes `-i '^README\.md$'` because leftover `README.md` files
29+
(see the section below) intentionally use non-standard link paths that
30+
aren't meant to be checked.
31+
32+
To check a file the same way CI does:
33+
```
34+
liche -p -h -l -s -i '^README\.md$' <file.md>
35+
```
36+
Never validate without `-s` and conclude links are broken — that check
37+
deliberately ignores the site's real routing.

docs/platform/guides/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,15 @@ 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](../guides/account-management/manage-profile/)
23+
- [Billing and Usage Guide](../guides/billing-and-usage-guide/overview)
24+
- [License Management](../guides/license-management/overview)
25+
- [Cluster Management](../guides/cluster-management/cluster-overview)
26+
- [Database Management](../guides/database-management/overview)
27+
- [Get Started](../guides/get-started/architecture)
28+
- [Integrations](../guides/integrations/rancher-extension)
29+
2930

3031
## Recommended path
3132

32-
For first-time users, start with [Get Started](../get-started/) and then move to the specific management areas relevant to your workflow.
33+
For first-time users, start with [Get Started](../guides/get-started/architecture) and then move to the specific management areas relevant to your workflow.
287 KB
Loading
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: docs
3+
menu:
4+
docsplatform_{{.version}}:
5+
identifier: database-management-overview
6+
name: Overview
7+
parent: database-management
8+
weight: 10
9+
menu_name: docsplatform_{{.version}}
10+
section_menu_id: guides
11+
---
12+
13+
## Overview <br>
14+
15+
**Database Management** is where you operate the databases provisioned through KubeDB Platform after they've been created. It brings the day-2 operational tasks — scaling, backup, restore, version upgrades, reconfiguration, TLS, monitoring, and more — into a single, per-database console so you don't need to reach for `kubectl` or hand-craft custom resources for routine work.
16+
17+
**Target Audience:** This guide is intended for `database administrators` and `operators` responsible for the ongoing health, availability, and data protection of databases running on KubeDB Platform.
18+
19+
![Database overview page showing status, resource usage, and available operations](../images/db-overview.png)
20+
21+
### Key Sections
22+
23+
- **[Database Usage & Insights](../database-usage-insight):** Monitor resource consumption and get at-a-glance health information for a database.
24+
- **[Scaling Databases](../scaling) / [Scaling Storages](../scaling-storage):** Adjust CPU, memory, replica count, or storage size — manually or through autoscaling policies.
25+
- **[Configure Backups](../backup), [Instant Backup & Restore](../instant-backup-restore), [Backup Restore](../restore):** Set up scheduled backups, trigger on-demand backups, and restore data when needed.
26+
- **[Upgrade Database Version](../upgrade-version), [Database Restarts](../restart-database), [Reconfigure Databases](../reconfigure-database):** Perform version upgrades, restarts, and configuration changes with minimal disruption.
27+
- **[Configure TLS](../tls), [Configure Monitoring](../monitoring), [Expose via Gateway](../expose-via-gateway):** Secure connections, enable Prometheus-based monitoring, and expose databases outside the cluster.
28+
- **[Manage Recommendations](../manage-recommendations), [Database Security Report](../security-report), [Database Constraint Violations](../contraint-violations):** Review platform-generated recommendations and compliance findings for a database.
29+
- **[Delete Database](../delete-database):** Safely remove a database and its associated resources.
30+
31+
Each operation is exposed as a dedicated form or panel in the left sidebar of a database's detail page. Under the hood, most actions are translated into Kubernetes `OpsRequest` custom resources, so every change is applied declaratively and can be tracked through its lifecycle — giving you the convenience of a UI with the auditability of GitOps-style operations.

docs/platform/selfhost-setup/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Welcome to KubeDB Platform's Self-Hosted deployment! Whether you're looking for
1919

2020
Navigate to [KubeDB Platform Self-Hosted](https://appscode.com/selfhost). Here you will find your previously generated self-hosted installers.
2121

22-
![Installer Home](../images/installer-home.png)
22+
![Installer Home](../selfhost-setup/images/installer-home.png)
2323
<br/>
2424

2525
<br/>
@@ -29,9 +29,9 @@ Click on the `Create New Installer` button to get started. You can choose variou
2929

3030
<br/>
3131

32-
To get detailed documentation on `Cloud Demo` installer, head over to [Demo Deployment](../install/cloud-demo.md).
32+
To get detailed documentation on `Cloud Demo` installer, head over to [Demo Deployment](../selfhost-setup/install/cloud-demo).
3333
<br/>
3434

3535
<br/>
3636

37-
To get detailed documentation on `Self Hosted Production` installer, head over to [Production Deployment](../install/selfhosted-production.md).
37+
To get detailed documentation on `Self Hosted Production` installer, head over to [Production Deployment](../selfhost-setup/install/selfhosted-production).

0 commit comments

Comments
 (0)