feat(docs): restructure documentation with new framework and templates

- Archive old docs to docs-old/ for reference
- Create new top-down documentation structure:
  * Platform Overview: purpose, audience, product structure
  * Components: individual platform components (Forgejo, Kubernetes, Backstage)
  * Getting Started: onboarding and quick start guides
  * Operations: deployment, monitoring, troubleshooting
  * Governance: ADRs, project history, compliance
- Add DOCUMENTATION-GUIDE.md with writing guidelines and templates
- Add component template (TEMPLATE.md) for consistent documentation
- Simplify root README and move technical docs to doc/ folder
- Update test configuration:
  * Exclude legacy content from markdown linting
  * Relax HTML validation for theme-generated content
  * Skip link checking for legacy content in test:links
  * Keep 'task test' clean for technical writers (100% pass)
  * Add 'task test:full' with comprehensive link checking
- Update home page with corrected markdown syntax
- Fix internal links in archived content

BREAKING CHANGE: Documentation structure changed from flat to hierarchical top-down approach
This commit is contained in:
Stephan Lo 2025-11-16 13:32:10 +01:00
parent 2ec2efe9fc
commit 62999b41d0
196 changed files with 907 additions and 160 deletions

View file

@ -44,25 +44,28 @@ Access the previous version of our documentation including historical project in
<div class="col-lg-4 mb-4">
### 🚀 Developer Experience
- **Backstage Portal** - Self-service platform
- **GitOps Workflows** - Automated deployments
- **Golden Paths** - Best practices built-in
* **Backstage Portal** - Self-service platform
* **GitOps Workflows** - Automated deployments
* **Golden Paths** - Best practices built-in
</div>
<div class="col-lg-4 mb-4">
### 🛠️ Infrastructure as Code
- **Crossplane** - Cloud resource provisioning
- **ArgoCD** - Declarative GitOps
- **Terraform** - Infrastructure automation
* **Crossplane** - Cloud resource provisioning
* **ArgoCD** - Declarative GitOps
* **Terraform** - Infrastructure automation
</div>
<div class="col-lg-4 mb-4">
### 📊 Observability
- **Prometheus & Grafana** - Metrics & dashboards
- **Loki** - Log aggregation
- **OpenTelemetry** - Distributed tracing
* **Prometheus & Grafana** - Metrics & dashboards
* **Loki** - Log aggregation
* **OpenTelemetry** - Distributed tracing
</div>
</div>
@ -75,9 +78,9 @@ Access the previous version of our documentation including historical project in
Whether you're a **platform engineer**, **application developer**, or **technicalWriter**, we have resources for you:
- 📖 Read the [Architecture Overview](/docs/architecture/highlevelarch/) to understand the system
- 🏗️ Explore [Platform Components](/docs/architecture/) and their interactions
- ✍️ Learn [How to Document](/docs/documentation/) and contribute to this site
- 🔍 Browse [Legacy Documentation](/docs/v1/) for historical context
* 📖 Read the [Documentation](/docs/) to understand the platform
* 🏗️ Explore [Platform Components](/docs/components/) and their usage
* ✍️ Learn [How to Document](/docs/DOCUMENTATION-GUIDE/) and contribute
* 🔍 Browse [Legacy Documentation](/docs-old/) for historical context
{{% /blocks/section %}}

23
content/en/docs-old/_index.md Executable file
View file

@ -0,0 +1,23 @@
---
title: Legacy Documentation
linkTitle: Docs (Old)
menu:
main:
weight: 50
weight: 50
cascade:
- type: docs
---
# Legacy Documentation
This section contains the previous version of the documentation for reference purposes.
**Note**: This documentation is archived and may be outdated. Please refer to the main [Documentation](../docs/) section for current information.
## Available Sections
* [Architecture](architecture/) - System architecture and diagrams
* [Documentation](documentation/) - Meta documentation about the documentation system
* [Platform Overview](platform-overview/) - Overview document
* [v1 (Legacy)](v1/) - Original v1 documentation

View file

@ -17,7 +17,7 @@ The diagram above is interactive when viewed in a compatible browser.
You can click on components to explore the architecture details.
**Note:** The interactive diagram requires the LikeC4 webcomponent to be generated.
See the [setup instructions]({{< ref "/docs/architecture/setup" >}}) for details.
See the [setup instructions]({{< ref "/docs-old/architecture/setup" >}}) for details.
{{< /alert >}}
## Architecture Overview
@ -76,4 +76,4 @@ To update or modify the architecture diagrams:
3. Commit both the model changes and the regenerated JavaScript file
For more information, see the [LikeC4 Integration Guide]({{< ref "/docs/architecture/setup" >}}).
For more information, see the [LikeC4 Integration Guide]({{< ref "/docs-old/architecture/setup" >}}).

View file

Before

Width:  |  Height:  |  Size: 154 KiB

After

Width:  |  Height:  |  Size: 154 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 944 KiB

After

Width:  |  Height:  |  Size: 944 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 160 KiB

After

Width:  |  Height:  |  Size: 160 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 113 KiB

After

Width:  |  Height:  |  Size: 113 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 364 KiB

After

Width:  |  Height:  |  Size: 364 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 208 KiB

After

Width:  |  Height:  |  Size: 208 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 212 KiB

After

Width:  |  Height:  |  Size: 212 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 96 KiB

After

Width:  |  Height:  |  Size: 96 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 243 KiB

After

Width:  |  Height:  |  Size: 243 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 302 KiB

After

Width:  |  Height:  |  Size: 302 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 264 KiB

After

Width:  |  Height:  |  Size: 264 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 295 KiB

After

Width:  |  Height:  |  Size: 295 KiB

Before After
Before After

Some files were not shown because too many files have changed in this diff Show more