Skip to content

Commit 541e4f0

Browse files
revert: drop README.md/_index.md merge from this PR
Keep only the mongodb horizon image addition; the README/_index.md consolidation will be handled separately. Signed-off-by: Arnob kumar saha <arnob@appscode.com>
1 parent e30576f commit 541e4f0

7 files changed

Lines changed: 101 additions & 75 deletions

File tree

CLAUDE.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,3 @@ liche -p -h -l -s <file.md>
3030
```
3131
Never validate without `-s` and conclude links are broken — that check
3232
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: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
layout: docs
3+
title: Welcome | KubeDB Platform
4+
menu:
5+
docsplatform_{{.version}}:
6+
identifier: platform-readme
7+
name: Welcome
8+
parent: welcome
9+
weight: -1
10+
menu_name: docsplatform_{{.version}}
11+
section_menu_id: welcome
12+
url: /docs/platform/{{.version}}/welcome/
13+
aliases:
14+
- /docs/platform/{{.version}}/
15+
- /docs/platform/{{.version}}/README/
16+
---
17+
18+
# KubeDB Platform Documentation
19+
20+
This page is the entry point for KubeDB Platform documentation.
21+
22+
## Core sections
23+
24+
- [Selfhost Setup](../selfhost-setup/)
25+
- [Guides](../guides/)
26+
27+
## Contributor resources
28+
29+
- [Contributing](../contributing.md)
30+
- [Support](../support.md)
31+
32+
Use [Guides](../guides/) for day-to-day workflows, then continue to [Selfhost Setup](../selfhost-setup/) for deployment-specific instructions.

docs/platform/_index.md

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,4 @@ menu:
77
name: Welcome
88
weight: 10
99
menu_name: docsplatform_{{.version}}
10-
aliases:
11-
- /docs/platform/{{.version}}/welcome/
12-
- /docs/platform/{{.version}}/README/
1310
---
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: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
layout: docs
3+
menu:
4+
docsplatform_{{.version}}:
5+
identifier: guides-readme
6+
name: Guides
7+
parent: guides
8+
weight: -1
9+
menu_name: docsplatform_{{.version}}
10+
section_menu_id: guides
11+
url: /docs/platform/{{.version}}/guides/
12+
aliases:
13+
- /docs/platform/{{.version}}/guides/README/
14+
---
15+
16+
# Platform Guides
17+
18+
This section contains practical, task-oriented guides for operating and managing the platform.
19+
20+
## Guide categories
21+
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/)
29+
30+
## Recommended path
31+
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/_index.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,4 @@ menu:
77
weight: 30
88
menu_name: docsplatform_{{.version}}
99
section_menu_id: guides
10-
aliases:
11-
- /docs/platform/{{.version}}/guides/README/
1210
---
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.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
layout: docs
3+
menu:
4+
docsplatform_{{.version}}:
5+
identifier: selfhost-setup-readme
6+
name: Selfhost Setup
7+
parent: selfhost-setup
8+
weight: -1
9+
menu_name: docsplatform_{{.version}}
10+
section_menu_id: selfhost-setup
11+
url: /docs/platform/{{.version}}/selfhost-setup/
12+
aliases:
13+
- /docs/platform/{{.version}}/selfhost-setup/README/
14+
---
15+
16+
# Host KubeDB Platform as Your Own
17+
18+
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.
19+
20+
Navigate to [KubeDB Platform Self-Hosted](https://appscode.com/selfhost). Here you will find your previously generated self-hosted installers.
21+
22+
![Installer Home](../images/installer-home.png)
23+
<br/>
24+
25+
<br/>
26+
27+
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.
28+
<br/>
29+
30+
<br/>
31+
32+
To get detailed documentation on `Cloud Demo` installer, head over to [Demo Deployment](../install/cloud-demo.md).
33+
<br/>
34+
35+
<br/>
36+
37+
To get detailed documentation on `Self Hosted Production` installer, head over to [Production Deployment](../install/selfhosted-production.md).

docs/platform/selfhost-setup/_index.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,4 @@ menu:
77
weight: 20
88
menu_name: docsplatform_{{.version}}
99
section_menu_id: selfhost-setup
10-
aliases:
11-
- /docs/platform/{{.version}}/selfhost-setup/README/
1210
---
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)