diff --git a/content/en/docs/components/TEMPLATE.md b/content/en/docs/components/TEMPLATE.md index d983a8f..db3759b 100644 --- a/content/en/docs/components/TEMPLATE.md +++ b/content/en/docs/components/TEMPLATE.md @@ -6,6 +6,20 @@ description: > [Brief one-line description of the component] --- +{{% alert title="Draft" color="warning" %}} +**Editorial Status**: This page is currently being developed. + +* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX) +* **Assignee**: [Name or Team] +* **Status**: Draft +* **Last Updated**: YYYY-MM-DD +* **TODO**: + * [ ] Add detailed component description + * [ ] Include usage examples and code samples + * [ ] Add architecture diagrams + * [ ] Review and finalize content +{{% /alert %}} + ## Overview [Detailed description of the component - what it is, what it does, and why it exists] @@ -20,10 +34,6 @@ description: > [Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities] -## Architecture - -[Optional: Brief architecture overview or link to detailed architecture documentation] - ## Repository **Code**: [Link to source code repository] diff --git a/content/en/docs/components/_index.md b/content/en/docs/components/_index.md index 977030a..e83c4bd 100644 --- a/content/en/docs/components/_index.md +++ b/content/en/docs/components/_index.md @@ -6,6 +6,19 @@ description: > Overview of EDP platform components and their integration. --- +{{% alert title="Draft" color="warning" %}} +**Editorial Status**: This page is currently being developed. + +* **Jira Ticket**: TBD +* **Assignee**: Team +* **Status**: Draft - Overview and template created +* **Last Updated**: 2025-11-16 +* **TODO**: + * [ ] Document each component based on product structure + * [ ] Add component maturity levels + * [ ] Include integration diagrams +{{% /alert %}} + ## Component Overview The Edge Developer Platform consists of multiple integrated components. Each component serves specific purposes in the overall platform architecture. diff --git a/content/en/docs/components/backstage.md b/content/en/docs/components/backstage.md deleted file mode 100644 index 18d433e..0000000 --- a/content/en/docs/components/backstage.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "Backstage" -linkTitle: "Backstage" -weight: 3 -description: > - Developer portal providing unified access to platform services and documentation. ---- - -## Overview - -Backstage provides a central developer portal for the EDP, offering unified access to services, documentation, and platform capabilities. - -## Key Features - -* Service catalog and component registry -* Software templates for rapid application creation -* Documentation hub -* Kubernetes visualization -* API documentation -* Plugin ecosystem for extensibility - -## Purpose in EDP - -Backstage serves as the entry point for developers, providing discoverability of platform capabilities and streamlined workflows. - -## Getting Started - -[To be documented: How to access and use Backstage portal] - -## Integration Points - -* **Forgejo/GitLab**: Repository and CI/CD integration -* **Kubernetes**: Resource visualization and management -* **ArgoCD**: Deployment status and controls -* **Documentation**: Centralized doc access - -## Status - -**Maturity**: Beta - -## Documentation Notes - -This is a template page. Team members should fill in: - -* Access URL and authentication -* Available plugins and features -* Creating new components from templates -* Service catalog usage -* Customization options diff --git a/content/en/docs/components/forgejo.md b/content/en/docs/components/forgejo.md index 349995b..5adb80c 100644 --- a/content/en/docs/components/forgejo.md +++ b/content/en/docs/components/forgejo.md @@ -6,6 +6,20 @@ description: > Self-hosted Git service with repository management and collaboration features. --- +{{% alert title="Draft" color="warning" %}} +**Editorial Status**: This page is currently being developed. + +* **Jira Ticket**: TBD +* **Assignee**: Team +* **Status**: Draft - Template populated +* **Last Updated**: 2025-11-16 +* **TODO**: + * [ ] Add deployment details and access information + * [ ] Include usage examples and workflows + * [ ] Add screenshots + * [ ] Document integration with Woodpecker CI +{{% /alert %}} + ## Overview Forgejo is a self-hosted Git service that provides repository management, issue tracking, pull requests, and collaboration features. It serves as a core component of the EDP for source code management. diff --git a/content/en/docs/components/kubernetes.md b/content/en/docs/components/kubernetes.md index f112752..683d626 100644 --- a/content/en/docs/components/kubernetes.md +++ b/content/en/docs/components/kubernetes.md @@ -6,6 +6,20 @@ description: > Container orchestration platform for deploying and managing applications. --- +{{% alert title="Draft" color="warning" %}} +**Editorial Status**: This page is currently being developed. + +* **Jira Ticket**: TBD +* **Assignee**: Team +* **Status**: Draft - Template populated +* **Last Updated**: 2025-11-16 +* **TODO**: + * [ ] Add cluster access procedures + * [ ] Document namespace structure + * [ ] Include deployment examples + * [ ] Add resource management guidelines +{{% /alert %}} + ## Overview Kubernetes provides the foundation for container orchestration in the EDP, enabling deployment, scaling, and management of containerized applications. diff --git a/content/en/docs/getting-started/_index.md b/content/en/docs/getting-started/_index.md index 59fb0b9..6dde0cd 100644 --- a/content/en/docs/getting-started/_index.md +++ b/content/en/docs/getting-started/_index.md @@ -6,6 +6,19 @@ description: > Quick start guides and onboarding information for the Edge Developer Platform. --- +{{% alert title="Draft" color="warning" %}} +**Editorial Status**: This page is currently being developed. + +* **Jira Ticket**: TBD +* **Assignee**: Team +* **Status**: Draft - Structure only +* **Last Updated**: 2025-11-16 +* **TODO**: + * [ ] Add concrete quick start steps + * [ ] Include prerequisites and access information + * [ ] Create first application tutorial +{{% /alert %}} + ## Welcome to EDP This section helps you get started with the Edge Developer Platform, whether you're a developer building applications or a platform engineer managing infrastructure. diff --git a/content/en/docs/governance/_index.md b/content/en/docs/governance/_index.md index d33b745..68554ef 100644 --- a/content/en/docs/governance/_index.md +++ b/content/en/docs/governance/_index.md @@ -6,6 +6,20 @@ description: > Project history, architecture decisions, compliance, and audit information. --- +{{% alert title="Draft" color="warning" %}} +**Editorial Status**: This page is currently being developed. + +* **Jira Ticket**: TBD +* **Assignee**: Team +* **Status**: Draft - Structure only +* **Last Updated**: 2025-11-16 +* **TODO**: + * [ ] Migrate relevant ADRs from docs-old + * [ ] Document project history and phases + * [ ] Add deliverables mapping + * [ ] Include compliance documentation +{{% /alert %}} + ## Governance Overview This section provides information for auditors, governance teams, and stakeholders who need to understand the project's decision-making process, history, and compliance. diff --git a/content/en/docs/operations/_index.md b/content/en/docs/operations/_index.md index db0db71..3bfdb5c 100644 --- a/content/en/docs/operations/_index.md +++ b/content/en/docs/operations/_index.md @@ -6,6 +6,20 @@ description: > Operational guides for deploying, monitoring, and maintaining the Edge Developer Platform. --- +{{% alert title="Draft" color="warning" %}} +**Editorial Status**: This page is currently being developed. + +* **Jira Ticket**: TBD +* **Assignee**: Team +* **Status**: Draft - Structure only +* **Last Updated**: 2025-11-16 +* **TODO**: + * [ ] Add deployment procedures + * [ ] Document monitoring setup and dashboards + * [ ] Include troubleshooting guides + * [ ] Add maintenance procedures +{{% /alert %}} + ## Operations Overview This section covers operational aspects of the Edge Developer Platform including deployment, monitoring, troubleshooting, and maintenance. diff --git a/content/en/docs/platform-overview/_index.md b/content/en/docs/platform-overview/_index.md index f116f64..b735759 100644 --- a/content/en/docs/platform-overview/_index.md +++ b/content/en/docs/platform-overview/_index.md @@ -6,6 +6,19 @@ description: > High-level overview of the Edge Developer Platform (EDP), its purpose, and product structure. --- +{{% alert title="Draft" color="warning" %}} +**Editorial Status**: This page is currently being developed. + +* **Jira Ticket**: TBD +* **Assignee**: Team +* **Status**: Draft - Initial structure created +* **Last Updated**: 2025-11-16 +* **TODO**: + * [ ] Add detailed product structure from excalidraw + * [ ] Include platform maturity matrix + * [ ] Add links to component pages as they are created +{{% /alert %}} + ## Purpose The Edge Developer Platform (EDP) is a comprehensive DevOps platform designed to enable developers to build, deploy, and operate cloud-native applications at the edge. It provides an integrated suite of tools and services covering the entire software development lifecycle.