Skip to content

Commit e30576f

Browse files
docs: merge duplicate README.md into _index.md, add missing mongodb horizon image
The welcome, guides, and selfhost-setup sections each had a leftover README.md from the VitePress migration sitting alongside the real Hugo _index.md, silently colliding on the same URL and breaking navigation on those pages. Merge README.md content into _index.md (porting aliases) and drop the duplicates. Also add the missing db-create/mongodb/horizon.png referenced by the mongodb+srv DNS docs, and document the extra-'../' link convention, liche's -s flag, and this README/_index collision pattern in CLAUDE.md so it doesn't need re-explaining. Signed-off-by: Arnob kumar saha <arnob@appscode.com>
1 parent 94d69e3 commit e30576f

8 files changed

Lines changed: 107 additions & 101 deletions

File tree

CLAUDE.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
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+
an extra flag: `-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+
To check a file the same way CI does:
28+
```
29+
liche -p -h -l -s <file.md>
30+
```
31+
Never validate without `-s` and conclude links are broken — that check
32+
deliberately ignores the site's real routing.
33+
34+
## README.md vs _index.md — do not let both exist in one directory
35+
36+
Hugo uses `_index.md` as a section's real index page. A few directories still
37+
had a leftover `README.md` from the VitePress days, front-matter-spoofing the
38+
same URL (or aliasing to it) — the two pages silently collided and broke
39+
navigation only on those pages, even though every relative-link rule above
40+
was followed correctly. If you find a directory with both, merge `README.md`'s
41+
body into `_index.md` (keep `_index.md`'s frontmatter, port any `aliases:`),
42+
then delete `README.md`. `docs/platform/`, `docs/platform/guides/`, and
43+
`docs/platform/selfhost-setup/` already went through this fix.

docs/platform/README.md

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

docs/platform/_index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,23 @@ menu:
77
name: Welcome
88
weight: 10
99
menu_name: docsplatform_{{.version}}
10+
aliases:
11+
- /docs/platform/{{.version}}/welcome/
12+
- /docs/platform/{{.version}}/README/
1013
---
14+
15+
# KubeDB Platform Documentation
16+
17+
This page is the entry point for KubeDB Platform documentation.
18+
19+
## Core sections
20+
21+
- [Selfhost Setup](../selfhost-setup/)
22+
- [Guides](../guides/)
23+
24+
## Contributor resources
25+
26+
- [Contributing](../contributing.md)
27+
- [Support](../support.md)
28+
29+
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: 0 additions & 32 deletions
This file was deleted.

docs/platform/guides/_index.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,24 @@ menu:
77
weight: 30
88
menu_name: docsplatform_{{.version}}
99
section_menu_id: guides
10+
aliases:
11+
- /docs/platform/{{.version}}/guides/README/
1012
---
13+
14+
# Platform Guides
15+
16+
This section contains practical, task-oriented guides for operating and managing the platform.
17+
18+
## Guide categories
19+
20+
- [Account Management](../account-management/)
21+
- [Billing and Usage Guide](../billing-and-usage-guide/)
22+
- [Cluster Management](../cluster-management/)
23+
- [Database Management](../database-management/)
24+
- [Get Started](../get-started/)
25+
- [Integrations](../integrations/)
26+
- [License Management](../license-management/)
27+
28+
## Recommended path
29+
30+
For first-time users, start with [Get Started](../get-started/) and then move to the specific management areas relevant to your workflow.
287 KB
Loading

docs/platform/selfhost-setup/README.md

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

docs/platform/selfhost-setup/_index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,29 @@ menu:
77
weight: 20
88
menu_name: docsplatform_{{.version}}
99
section_menu_id: selfhost-setup
10+
aliases:
11+
- /docs/platform/{{.version}}/selfhost-setup/README/
1012
---
13+
14+
# Host KubeDB Platform as Your Own
15+
16+
Welcome to KubeDB Platform's Self-Hosted deployment! Whether you're looking for a quick trial in "Self Hosted Demo" mode or gearing up for a production-ready environment (`Self Hosted Production`), you're in control.
17+
18+
Navigate to [KubeDB Platform Self-Hosted](https://appscode.com/selfhost). Here you will find your previously generated self-hosted installers.
19+
20+
![Installer Home](../images/installer-home.png)
21+
<br/>
22+
23+
<br/>
24+
25+
Click on the `Create New Installer` button to get started. You can choose various deployment types including `Cloud Demo` or `Self Hosted Production`. Provide the required data and click `Done` button to generate the installer. Upon generation of the installer, you will get the documentation how to host KubeDB Platform Server on your own.
26+
<br/>
27+
28+
<br/>
29+
30+
To get detailed documentation on `Cloud Demo` installer, head over to [Demo Deployment](../install/cloud-demo.md).
31+
<br/>
32+
33+
<br/>
34+
35+
To get detailed documentation on `Self Hosted Production` installer, head over to [Production Deployment](../install/selfhosted-production.md).

0 commit comments

Comments
 (0)