From 6bd7f6b5a158bf9771307532269324c85af85645 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Mon, 17 Nov 2025 19:44:01 +0100 Subject: [PATCH] doc(stacks): added deployments documentation frame according to IPCEICIS-6733 --- .../en/docs/components/deployments/_index.md | 4 +- .../{edgeconnect.md => edgeconnect/_index.md} | 0 .../{ => edgeconnect}/edgeconnect-client.md | 0 .../edgeconnect/edgeconnect-sdk.md | 128 ++++++++++++++++++ content/en/docs/components/deployments/otc.md | 4 +- .../orchestration/infrastructure/_index.md | 2 +- .../orchestration/infrastructure/provider.md | 2 +- .../orchestration/infrastructure/terraform.md | 2 +- .../components/orchestration/stacks/_index.md | 2 +- 9 files changed, 136 insertions(+), 8 deletions(-) rename content/en/docs/components/deployments/{edgeconnect.md => edgeconnect/_index.md} (100%) rename content/en/docs/components/deployments/{ => edgeconnect}/edgeconnect-client.md (100%) create mode 100644 content/en/docs/components/deployments/edgeconnect/edgeconnect-sdk.md diff --git a/content/en/docs/components/deployments/_index.md b/content/en/docs/components/deployments/_index.md index 3698a67..c68c6ff 100644 --- a/content/en/docs/components/deployments/_index.md +++ b/content/en/docs/components/deployments/_index.md @@ -9,8 +9,8 @@ description: > {{% 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] +* **Jira Ticket**: [TICKET-6733](https://jira.telekom-mms.com/browse/IPCEICIS-6733) +* **Assignee**: Patrick * **Status**: Draft * **Last Updated**: YYYY-MM-DD * **TODO**: diff --git a/content/en/docs/components/deployments/edgeconnect.md b/content/en/docs/components/deployments/edgeconnect/_index.md similarity index 100% rename from content/en/docs/components/deployments/edgeconnect.md rename to content/en/docs/components/deployments/edgeconnect/_index.md diff --git a/content/en/docs/components/deployments/edgeconnect-client.md b/content/en/docs/components/deployments/edgeconnect/edgeconnect-client.md similarity index 100% rename from content/en/docs/components/deployments/edgeconnect-client.md rename to content/en/docs/components/deployments/edgeconnect/edgeconnect-client.md diff --git a/content/en/docs/components/deployments/edgeconnect/edgeconnect-sdk.md b/content/en/docs/components/deployments/edgeconnect/edgeconnect-sdk.md new file mode 100644 index 0000000..5500feb --- /dev/null +++ b/content/en/docs/components/deployments/edgeconnect/edgeconnect-sdk.md @@ -0,0 +1,128 @@ +--- +title: "EdgeConnect SDK" +linkTitle: "EdgeConnect SDK" +weight: 10 +description: > + Software Development Kit for establishing EdgeConnect connections +--- + +{{% 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/deployments/otc.md b/content/en/docs/components/deployments/otc.md index c958d93..2ee32f5 100644 --- a/content/en/docs/components/deployments/otc.md +++ b/content/en/docs/components/deployments/otc.md @@ -9,8 +9,8 @@ description: > {{% 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] +* **Jira Ticket**: [TICKET-6733](https://jira.telekom-mms.com/browse/IPCEICIS-6733) +* **Assignee**: Patrick * **Status**: Draft * **Last Updated**: YYYY-MM-DD * **TODO**: diff --git a/content/en/docs/components/orchestration/infrastructure/_index.md b/content/en/docs/components/orchestration/infrastructure/_index.md index 4f7e6ec..fc84a9d 100644 --- a/content/en/docs/components/orchestration/infrastructure/_index.md +++ b/content/en/docs/components/orchestration/infrastructure/_index.md @@ -9,7 +9,7 @@ description: > {{% alert title="Draft" color="warning" %}} **Editorial Status**: This page is currently being developed. -* **Jira Ticket**: [TICKET-6732](https://jira.telekom-mms.com/browse/IPCEICIS-6732)) +* **Jira Ticket**: [TICKET-6732](https://jira.telekom-mms.com/browse/IPCEICIS-6732) * **Assignee**: Martin * **Status**: Draft * **Last Updated**: YYYY-MM-DD diff --git a/content/en/docs/components/orchestration/infrastructure/provider.md b/content/en/docs/components/orchestration/infrastructure/provider.md index c6e8c46..236c0cc 100644 --- a/content/en/docs/components/orchestration/infrastructure/provider.md +++ b/content/en/docs/components/orchestration/infrastructure/provider.md @@ -8,7 +8,7 @@ description: Used Provider we deploy on {{% alert title="Draft" color="warning" %}} **Editorial Status**: This page is currently being developed. -* **Jira Ticket**: [TICKET-6732](https://jira.telekom-mms.com/browse/IPCEICIS-6732)) +* **Jira Ticket**: [TICKET-6732](https://jira.telekom-mms.com/browse/IPCEICIS-6732) * **Assignee**: Martin * **Status**: Draft * **Last Updated**: YYYY-MM-DD diff --git a/content/en/docs/components/orchestration/infrastructure/terraform.md b/content/en/docs/components/orchestration/infrastructure/terraform.md index 5985ecb..69e1813 100644 --- a/content/en/docs/components/orchestration/infrastructure/terraform.md +++ b/content/en/docs/components/orchestration/infrastructure/terraform.md @@ -9,7 +9,7 @@ description: > {{% alert title="Draft" color="warning" %}} **Editorial Status**: This page is currently being developed. -* **Jira Ticket**: [TICKET-6732](https://jira.telekom-mms.com/browse/IPCEICIS-6732)) +* **Jira Ticket**: [TICKET-6732](https://jira.telekom-mms.com/browse/IPCEICIS-6732) * **Assignee**: Martin * **Status**: Draft * **Last Updated**: YYYY-MM-DD diff --git a/content/en/docs/components/orchestration/stacks/_index.md b/content/en/docs/components/orchestration/stacks/_index.md index 1c23b2d..f8d30b1 100644 --- a/content/en/docs/components/orchestration/stacks/_index.md +++ b/content/en/docs/components/orchestration/stacks/_index.md @@ -10,7 +10,7 @@ description: > **Editorial Status**: This page is currently being developed. * **Jira Ticket**: [TICKET-6729](https://jira.telekom-mms.com/browse/IPCEICIS-6729) -* **Assignee**: [Name or Team] +* **Assignee**: Stephan * **Status**: Draft * **Last Updated**: YYYY-MM-DD * **TODO**: