From 829895fa73a2df2f14c1eeb1ca8729ea36ea95cb Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Mon, 17 Nov 2025 19:14:32 +0100 Subject: [PATCH] doc(stacks): added stacks documentation farme according to IPCEICIS-6729 --- content/en/docs/components/forgejo/forgejo.md | 2 +- .../components/orchestration/application.md | 128 ++++++++++++++++++ ...ture-provisioning.md => infrastructure.md} | 6 +- .../{platform-provisioning.md => platform.md} | 6 +- .../{stacks.md => stacks/_index.md} | 4 +- .../orchestration/stacks/component-1.md | 128 ++++++++++++++++++ .../orchestration/stacks/component-2.md | 128 ++++++++++++++++++ 7 files changed, 393 insertions(+), 9 deletions(-) create mode 100644 content/en/docs/components/orchestration/application.md rename content/en/docs/components/orchestration/{infrastructure-provisioning.md => infrastructure.md} (96%) rename content/en/docs/components/orchestration/{platform-provisioning.md => platform.md} (96%) rename content/en/docs/components/orchestration/{stacks.md => stacks/_index.md} (96%) create mode 100644 content/en/docs/components/orchestration/stacks/component-1.md create mode 100644 content/en/docs/components/orchestration/stacks/component-2.md diff --git a/content/en/docs/components/forgejo/forgejo.md b/content/en/docs/components/forgejo/forgejo.md index 29103b9..c358644 100644 --- a/content/en/docs/components/forgejo/forgejo.md +++ b/content/en/docs/components/forgejo/forgejo.md @@ -11,7 +11,7 @@ weight: 10 {{% alert title="Draft" color="warning" %}} **Editorial Status**: This page is currently being developed. -* **Jira Ticket**: https://jira.telekom-mms.com/browse/IPCEICIS-6731 +* **Jira Ticket**: [TICKET-6731](https://jira.telekom-mms.com/browse/IPCEICIS-6731) * **Assignee**: Daniel * **Status**: Draft * **Last Updated**: 2025-11-17 diff --git a/content/en/docs/components/orchestration/application.md b/content/en/docs/components/orchestration/application.md new file mode 100644 index 0000000..6c6fe3b --- /dev/null +++ b/content/en/docs/components/orchestration/application.md @@ -0,0 +1,128 @@ +--- +title: "Application Orchestration" +linkTitle: "Application Orchestration" +weight: 50 +description: > + Application-level component provisioning via Stacks +--- + +{{% 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] + +## Key Features + +* [Feature 1] +* [Feature 2] +* [Feature 3] + +## Purpose in EDP + +[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities] + +## Repository + +**Code**: [Link to source code repository] + +**Documentation**: [Link to component-specific documentation] + +## Getting Started + +### Prerequisites + +* [Prerequisite 1] +* [Prerequisite 2] + +### Quick Start + +[Step-by-step guide to get started with this component] + +1. [Step 1] +2. [Step 2] +3. [Step 3] + +### Verification + +[How to verify the component is working correctly] + +## Usage Examples + +### [Use Case 1] + +[Example with code/commands showing common use case] + +```bash +# Example commands +``` + +### [Use Case 2] + +[Another common scenario] + +## Integration Points + +* **[Component A]**: [How it integrates] +* **[Component B]**: [How it integrates] +* **[Component C]**: [How it integrates] + +## Architecture + +[Optional: Add architectural diagrams and descriptions] + +### Component Architecture (C4) + +[Add C4 Container or Component diagrams showing the internal structure] + +### Sequence Diagrams + +[Add sequence diagrams showing key interaction flows with other components] + +### Deployment Architecture + +[Add infrastructure and deployment diagrams showing how the component is deployed] + +## Configuration + +[Key configuration options and how to set them] + +## Troubleshooting + +### [Common Issue 1] + +**Problem**: [Description] + +**Solution**: [How to fix] + +### [Common Issue 2] + +**Problem**: [Description] + +**Solution**: [How to fix] + +## Status + +**Maturity**: [Production / Beta / Experimental] + +## Additional Resources + +* [Link to external documentation] +* [Link to community resources] +* [Link to related components] + +## Documentation Notes + +[Instructions for team members filling in this documentation - remove this section once complete] diff --git a/content/en/docs/components/orchestration/infrastructure-provisioning.md b/content/en/docs/components/orchestration/infrastructure.md similarity index 96% rename from content/en/docs/components/orchestration/infrastructure-provisioning.md rename to content/en/docs/components/orchestration/infrastructure.md index aef2bbd..b36f4ac 100644 --- a/content/en/docs/components/orchestration/infrastructure-provisioning.md +++ b/content/en/docs/components/orchestration/infrastructure.md @@ -1,7 +1,7 @@ --- -title: "Infrastructure Provisioning" -linkTitle: "Infrastructure" -weight: 10 +title: "Infrastructure Orchestration" +linkTitle: "Infrastructure Orchestration" +weight: 20 description: > Infrastructure deployment and catalog management (infra-deploy, infra-catalogue) --- diff --git a/content/en/docs/components/orchestration/platform-provisioning.md b/content/en/docs/components/orchestration/platform.md similarity index 96% rename from content/en/docs/components/orchestration/platform-provisioning.md rename to content/en/docs/components/orchestration/platform.md index 162ef9f..447f55d 100644 --- a/content/en/docs/components/orchestration/platform-provisioning.md +++ b/content/en/docs/components/orchestration/platform.md @@ -1,7 +1,7 @@ --- -title: "Platform Provisioning" -linkTitle: "Platform" -weight: 20 +title: "Platform Orchestration" +linkTitle: "Platform Orchestration" +weight: 30 description: > Platform-level component provisioning via Stacks --- diff --git a/content/en/docs/components/orchestration/stacks.md b/content/en/docs/components/orchestration/stacks/_index.md similarity index 96% rename from content/en/docs/components/orchestration/stacks.md rename to content/en/docs/components/orchestration/stacks/_index.md index da659c6..756cb80 100644 --- a/content/en/docs/components/orchestration/stacks.md +++ b/content/en/docs/components/orchestration/stacks/_index.md @@ -1,7 +1,7 @@ --- title: "Stacks" linkTitle: "Stacks" -weight: 20 +weight: 10 description: > Platform-level component provisioning via Stacks --- @@ -9,7 +9,7 @@ description: > {{% alert title="Draft" color="warning" %}} **Editorial Status**: This page is currently being developed. -* **Jira Ticket**: [TICKET-6418](https://your-jira/browse/TICKET-XXX) +* **Jira Ticket**: [TICKET-6729](https://jira.telekom-mms.com/browse/IPCEICIS-6729) * **Assignee**: [Name or Team] * **Status**: Draft * **Last Updated**: YYYY-MM-DD diff --git a/content/en/docs/components/orchestration/stacks/component-1.md b/content/en/docs/components/orchestration/stacks/component-1.md new file mode 100644 index 0000000..4f6b18c --- /dev/null +++ b/content/en/docs/components/orchestration/stacks/component-1.md @@ -0,0 +1,128 @@ +--- +title: "Component 1" +linkTitle: "Component 1" +weight: 20 +description: > + Component 1 +--- + +{{% alert title="Draft" color="warning" %}} +**Editorial Status**: This page is currently being developed. + +* **Jira Ticket**: [TBD] +* **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] + +## Key Features + +* [Feature 1] +* [Feature 2] +* [Feature 3] + +## Purpose in EDP + +[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities] + +## Repository + +**Code**: [Link to source code repository] + +**Documentation**: [Link to component-specific documentation] + +## Getting Started + +### Prerequisites + +* [Prerequisite 1] +* [Prerequisite 2] + +### Quick Start + +[Step-by-step guide to get started with this component] + +1. [Step 1] +2. [Step 2] +3. [Step 3] + +### Verification + +[How to verify the component is working correctly] + +## Usage Examples + +### [Use Case 1] + +[Example with code/commands showing common use case] + +```bash +# Example commands +``` + +### [Use Case 2] + +[Another common scenario] + +## Integration Points + +* **[Component A]**: [How it integrates] +* **[Component B]**: [How it integrates] +* **[Component C]**: [How it integrates] + +## Architecture + +[Optional: Add architectural diagrams and descriptions] + +### Component Architecture (C4) + +[Add C4 Container or Component diagrams showing the internal structure] + +### Sequence Diagrams + +[Add sequence diagrams showing key interaction flows with other components] + +### Deployment Architecture + +[Add infrastructure and deployment diagrams showing how the component is deployed] + +## Configuration + +[Key configuration options and how to set them] + +## Troubleshooting + +### [Common Issue 1] + +**Problem**: [Description] + +**Solution**: [How to fix] + +### [Common Issue 2] + +**Problem**: [Description] + +**Solution**: [How to fix] + +## Status + +**Maturity**: [Production / Beta / Experimental] + +## Additional Resources + +* [Link to external documentation] +* [Link to community resources] +* [Link to related components] + +## Documentation Notes + +[Instructions for team members filling in this documentation - remove this section once complete] diff --git a/content/en/docs/components/orchestration/stacks/component-2.md b/content/en/docs/components/orchestration/stacks/component-2.md new file mode 100644 index 0000000..0244aa7 --- /dev/null +++ b/content/en/docs/components/orchestration/stacks/component-2.md @@ -0,0 +1,128 @@ +--- +title: "Component 2" +linkTitle: "Component 2" +weight: 30 +description: > + Component 2 +--- + +{{% alert title="Draft" color="warning" %}} +**Editorial Status**: This page is currently being developed. + +* **Jira Ticket**: [TBD] +* **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] + +## Key Features + +* [Feature 1] +* [Feature 2] +* [Feature 3] + +## Purpose in EDP + +[Explain the role this component plays in the Edge Developer Platform and how it contributes to the overall platform capabilities] + +## Repository + +**Code**: [Link to source code repository] + +**Documentation**: [Link to component-specific documentation] + +## Getting Started + +### Prerequisites + +* [Prerequisite 1] +* [Prerequisite 2] + +### Quick Start + +[Step-by-step guide to get started with this component] + +1. [Step 1] +2. [Step 2] +3. [Step 3] + +### Verification + +[How to verify the component is working correctly] + +## Usage Examples + +### [Use Case 1] + +[Example with code/commands showing common use case] + +```bash +# Example commands +``` + +### [Use Case 2] + +[Another common scenario] + +## Integration Points + +* **[Component A]**: [How it integrates] +* **[Component B]**: [How it integrates] +* **[Component C]**: [How it integrates] + +## Architecture + +[Optional: Add architectural diagrams and descriptions] + +### Component Architecture (C4) + +[Add C4 Container or Component diagrams showing the internal structure] + +### Sequence Diagrams + +[Add sequence diagrams showing key interaction flows with other components] + +### Deployment Architecture + +[Add infrastructure and deployment diagrams showing how the component is deployed] + +## Configuration + +[Key configuration options and how to set them] + +## Troubleshooting + +### [Common Issue 1] + +**Problem**: [Description] + +**Solution**: [How to fix] + +### [Common Issue 2] + +**Problem**: [Description] + +**Solution**: [How to fix] + +## Status + +**Maturity**: [Production / Beta / Experimental] + +## Additional Resources + +* [Link to external documentation] +* [Link to community resources] +* [Link to related components] + +## Documentation Notes + +[Instructions for team members filling in this documentation - remove this section once complete]