feat(doc-structure): documentation structure ready for team development or writing resp.
This commit is contained in:
parent
4935913002
commit
f0ca9bbce2
32 changed files with 1911 additions and 1714 deletions
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Documentation Guide"
|
||||
linkTitle: "Documentation Guide"
|
||||
weight: 100
|
||||
weight: 1
|
||||
description: >
|
||||
Guidelines and templates for creating EDP documentation.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "[Component Name]"
|
||||
linkTitle: "[Short Name]"
|
||||
weight: 99
|
||||
weight: 1
|
||||
description: >
|
||||
[Brief one-line description of the component]
|
||||
---
|
||||
|
|
@ -79,6 +79,35 @@ description: >
|
|||
* **[Component B]**: [How it integrates]
|
||||
* **[Component C]**: [How it integrates]
|
||||
|
||||
## Architecture
|
||||
|
||||
[Optional: Add architectural diagrams and descriptions]
|
||||
|
||||
### C4 charts
|
||||
|
||||
Embed C4 charts this way:
|
||||
|
||||
1. add a likec4-view with the name of the view
|
||||
{{< likec4-view view="components-template-documentation" project="architecture" title="Example Documentation Diagram" >}}
|
||||
|
||||
2. create the LikeC4 view somewhere in ```./resources/edp-likec4/views```, the example above is in ```./resources/edp-likec4/views/documentation/components-template-documentation.c4```
|
||||
|
||||
3. run ```task likec4:generate``` to create the webcomponent
|
||||
|
||||
4. if you are in ```task:serve``` hot-reload mode the view will show up directly
|
||||
|
||||
### 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]
|
||||
|
|
|
|||
|
|
@ -1,87 +1,21 @@
|
|||
---
|
||||
title: "Components"
|
||||
linkTitle: "Components"
|
||||
weight: 2
|
||||
weight: 30
|
||||
description: >
|
||||
Overview of EDP platform components and their integration.
|
||||
---
|
||||
|
||||
{{% alert title="Draft" color="warning" %}}
|
||||
**Editorial Status**: This page is currently being developed.
|
||||
This section documents all components of the Edge Developer Platform based on the product structure.
|
||||
|
||||
* **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 Categories
|
||||
|
||||
## Component Overview
|
||||
The EDP consists of the following main component categories:
|
||||
|
||||
The Edge Developer Platform consists of multiple integrated components. Each component serves specific purposes in the overall platform architecture.
|
||||
* **Orchestrator**: Platform and infrastructure orchestration
|
||||
* **Forgejo & CI/CD**: Source code management and automation
|
||||
* **Deployments**: Deployment targets and edge connectivity
|
||||
* **Dev Environments**: Development environment provisioning
|
||||
* **Physical Environments**: Runtime infrastructure
|
||||
|
||||
This section provides detailed documentation for each component, including:
|
||||
|
||||
* Description and purpose
|
||||
* Key features and capabilities
|
||||
* Repository links and resources
|
||||
* Usage instructions and examples
|
||||
* Integration points with other components
|
||||
|
||||
## Core Components
|
||||
|
||||
### Source Code Management
|
||||
|
||||
**Forgejo**: Self-hosted Git service with repository management, issue tracking, and collaboration features.
|
||||
|
||||
**GitLab**: Enterprise-grade Git repository management with CI/CD integration.
|
||||
|
||||
### Container Orchestration
|
||||
|
||||
**Kubernetes**: Container orchestration platform for deploying and managing containerized applications.
|
||||
|
||||
### CI/CD & Automation
|
||||
|
||||
**Woodpecker**: Lightweight CI/CD server with pipeline automation.
|
||||
|
||||
**GARM**: GitHub Actions-compatible runner manager for self-hosted environments.
|
||||
|
||||
**ArgoCD**: GitOps continuous delivery tool for Kubernetes.
|
||||
|
||||
### Developer Portal
|
||||
|
||||
**Backstage**: Developer portal providing unified interface for platform services, documentation, and tooling.
|
||||
|
||||
### Observability
|
||||
|
||||
**VictoriaMetrics**: Time-series database for metrics storage and querying.
|
||||
|
||||
**Prometheus**: Metrics collection and alerting.
|
||||
|
||||
**Grafana**: Visualization and dashboards for metrics and logs.
|
||||
|
||||
### Infrastructure as Code
|
||||
|
||||
**Terraform**: Infrastructure provisioning and management.
|
||||
|
||||
**Crossplane**: Kubernetes-native infrastructure management.
|
||||
|
||||
## Component Status
|
||||
|
||||
Each component page includes current status and maturity level. Check individual component documentation for detailed information.
|
||||
|
||||
## Template for Component Documentation
|
||||
|
||||
When documenting a component, include:
|
||||
|
||||
1. **Overview**: Brief description and purpose
|
||||
2. **Key Features**: Main capabilities and use cases
|
||||
3. **Architecture**: How it fits into EDP
|
||||
4. **Getting Started**: Quick start guide
|
||||
5. **Usage Examples**: Common scenarios and patterns
|
||||
6. **Repository**: Link to source code and additional resources
|
||||
7. **Integration**: Connection points with other components
|
||||
8. **Status**: Current maturity level
|
||||

|
||||
14
content/en/docs/components/deployments/_index.md
Normal file
14
content/en/docs/components/deployments/_index.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
title: "Deployments"
|
||||
linkTitle: "Deployments"
|
||||
weight: 40
|
||||
description: >
|
||||
Deployment targets and edge connectivity solutions.
|
||||
---
|
||||
|
||||
Deployment components manage connections to various deployment targets including cloud infrastructure and edge devices.
|
||||
|
||||
## Components
|
||||
|
||||
* **OTC**: Open Telekom Cloud deployment target
|
||||
* **EdgeConnect**: Secure edge connectivity solution
|
||||
128
content/en/docs/components/deployments/edgeconnect-client.md
Normal file
128
content/en/docs/components/deployments/edgeconnect-client.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
title: "EdgeConnect Client"
|
||||
linkTitle: "EdgeConnect Client"
|
||||
weight: 30
|
||||
description: >
|
||||
Client software 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]
|
||||
128
content/en/docs/components/deployments/edgeconnect.md
Normal file
128
content/en/docs/components/deployments/edgeconnect.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
title: "EdgeConnect"
|
||||
linkTitle: "EdgeConnect"
|
||||
weight: 20
|
||||
description: >
|
||||
Secure connectivity solution for edge devices and environments
|
||||
---
|
||||
|
||||
{{% 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]
|
||||
128
content/en/docs/components/deployments/otc.md
Normal file
128
content/en/docs/components/deployments/otc.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
title: "OTC (Open Telekom Cloud)"
|
||||
linkTitle: "OTC"
|
||||
weight: 10
|
||||
description: >
|
||||
Open Telekom Cloud deployment and infrastructure target
|
||||
---
|
||||
|
||||
{{% 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]
|
||||
128
content/en/docs/components/dev-environments.md
Normal file
128
content/en/docs/components/dev-environments.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
title: "Development Environments"
|
||||
linkTitle: "DevEnvironments"
|
||||
weight: 30
|
||||
description: >
|
||||
Development environment provisioning and management
|
||||
---
|
||||
|
||||
{{% 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]
|
||||
|
|
@ -1,68 +0,0 @@
|
|||
---
|
||||
title: "Forgejo"
|
||||
linkTitle: "Forgejo"
|
||||
weight: 1
|
||||
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.
|
||||
|
||||
## Key Features
|
||||
|
||||
* Git repository hosting
|
||||
* Issue tracking and project management
|
||||
* Pull requests and code review
|
||||
* CI/CD integration with Woodpecker
|
||||
* User and organization management
|
||||
* API for automation and integration
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
Forgejo serves as the primary source code management platform, providing developers with a familiar Git workflow while maintaining full control over the hosting infrastructure.
|
||||
|
||||
## Repository
|
||||
|
||||
**Code**: [Link to Forgejo repository]
|
||||
|
||||
**Documentation**: [Link to Forgejo-specific documentation]
|
||||
|
||||
## Getting Started
|
||||
|
||||
[To be documented: Quick start guide for using Forgejo in EDP]
|
||||
|
||||
## Integration Points
|
||||
|
||||
* **Woodpecker CI**: Automated pipeline triggers on git events
|
||||
* **ArgoCD**: GitOps repository source
|
||||
* **Backstage**: Service catalog integration
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: Production
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
This is a template page. Team members should fill in:
|
||||
|
||||
* Specific deployment details
|
||||
* Access URLs and credentials management
|
||||
* Common workflows and usage patterns
|
||||
* Troubleshooting information
|
||||
* Screenshots or examples
|
||||
14
content/en/docs/components/forgejo/_index.md
Normal file
14
content/en/docs/components/forgejo/_index.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
title: "Forgejo"
|
||||
linkTitle: "Forgejo"
|
||||
weight: 20
|
||||
description: >
|
||||
Self-hosted Git service with project management and CI/CD capabilities.
|
||||
---
|
||||
|
||||
Forgejo provides source code management, project management, and CI/CD automation for the EDP.
|
||||
|
||||
## Sub-Components
|
||||
|
||||
* **Project Management**: Issue tracking and project management features
|
||||
* **Actions**: CI/CD automation (see CI/CD section)
|
||||
128
content/en/docs/components/forgejo/actions.md
Normal file
128
content/en/docs/components/forgejo/actions.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
title: "Forgejo Actions"
|
||||
linkTitle: "Actions"
|
||||
weight: 10
|
||||
description: >
|
||||
GitHub Actions-compatible CI/CD automation
|
||||
---
|
||||
|
||||
{{% 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]
|
||||
128
content/en/docs/components/forgejo/project-mgmt.md
Normal file
128
content/en/docs/components/forgejo/project-mgmt.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
title: "Project Management"
|
||||
linkTitle: "Project Mgmt"
|
||||
weight: 10
|
||||
description: >
|
||||
Project and issue management capabilities within Forgejo
|
||||
---
|
||||
|
||||
{{% 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]
|
||||
128
content/en/docs/components/forgejo/runner.md
Normal file
128
content/en/docs/components/forgejo/runner.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
title: "Action Runner"
|
||||
linkTitle: "Runner"
|
||||
weight: 20
|
||||
description: >
|
||||
Self-hosted runner infrastructure with orchestration capabilities
|
||||
---
|
||||
|
||||
{{% 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]
|
||||
|
|
@ -1,62 +0,0 @@
|
|||
---
|
||||
title: "Kubernetes"
|
||||
linkTitle: "Kubernetes"
|
||||
weight: 2
|
||||
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.
|
||||
|
||||
## Key Features
|
||||
|
||||
* Container orchestration and scheduling
|
||||
* Service discovery and load balancing
|
||||
* Storage orchestration
|
||||
* Self-healing and automated rollouts
|
||||
* Configuration and secret management
|
||||
|
||||
## Purpose in EDP
|
||||
|
||||
Kubernetes serves as the runtime platform for all EDP components and user applications, providing standardized deployment and operations.
|
||||
|
||||
## Getting Started
|
||||
|
||||
[To be documented: Quick start for deploying to Kubernetes in EDP]
|
||||
|
||||
## Integration Points
|
||||
|
||||
* **ArgoCD**: Kubernetes deployment automation
|
||||
* **Crossplane**: Infrastructure provisioning on Kubernetes
|
||||
* **VictoriaMetrics/Prometheus**: Kubernetes metrics collection
|
||||
* **Backstage**: Kubernetes resource visualization
|
||||
|
||||
## Status
|
||||
|
||||
**Maturity**: Production
|
||||
|
||||
## Documentation Notes
|
||||
|
||||
This is a template page. Team members should fill in:
|
||||
|
||||
* Cluster access procedures
|
||||
* Namespace organization
|
||||
* Resource quotas and limits
|
||||
* Network policies
|
||||
* Storage classes and PV management
|
||||
14
content/en/docs/components/orchestrator/_index.md
Normal file
14
content/en/docs/components/orchestrator/_index.md
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
---
|
||||
title: "Orchestrator"
|
||||
linkTitle: "Orchestrator"
|
||||
weight: 10
|
||||
description: >
|
||||
Platform and infrastructure orchestration components.
|
||||
---
|
||||
|
||||
The Orchestrator manages platform and infrastructure provisioning, providing the foundation for the EDP deployment model.
|
||||
|
||||
## Sub-Components
|
||||
|
||||
* **Infrastructure Provisioning**: Low-level infrastructure deployment (infra-deploy, infra-catalogue)
|
||||
* **Platform Provisioning**: Platform-level component deployment via Stacks
|
||||
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
title: "Infrastructure Provisioning"
|
||||
linkTitle: "Infrastructure"
|
||||
weight: 10
|
||||
description: >
|
||||
Infrastructure deployment and catalog management (infra-deploy, infra-catalogue)
|
||||
---
|
||||
|
||||
{{% 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]
|
||||
128
content/en/docs/components/orchestrator/platform-provisioning.md
Normal file
128
content/en/docs/components/orchestrator/platform-provisioning.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
title: "Platform Provisioning"
|
||||
linkTitle: "Platform"
|
||||
weight: 20
|
||||
description: >
|
||||
Platform-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]
|
||||
16
content/en/docs/components/physical-envs/_index.md
Normal file
16
content/en/docs/components/physical-envs/_index.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
title: "Physical Environments"
|
||||
linkTitle: "Physical Envs"
|
||||
weight: 60
|
||||
description: >
|
||||
Physical runtime environments and infrastructure providers.
|
||||
---
|
||||
|
||||
Physical environment components provide the runtime infrastructure for deploying and running applications.
|
||||
|
||||
## Components
|
||||
|
||||
* **Docker**: Container runtime
|
||||
* **Kubernetes**: Container orchestration
|
||||
* **LXC**: Linux Containers
|
||||
* **Provider**: Infrastructure provider abstraction
|
||||
128
content/en/docs/components/physical-envs/docker.md
Normal file
128
content/en/docs/components/physical-envs/docker.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
title: "Docker"
|
||||
linkTitle: "Docker"
|
||||
weight: 10
|
||||
description: >
|
||||
Container runtime for running containerized applications
|
||||
---
|
||||
|
||||
{{% 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]
|
||||
128
content/en/docs/components/physical-envs/kubernetes.md
Normal file
128
content/en/docs/components/physical-envs/kubernetes.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
title: "Kubernetes"
|
||||
linkTitle: "Kubernetes"
|
||||
weight: 20
|
||||
description: >
|
||||
Container orchestration platform for managing containerized workloads
|
||||
---
|
||||
|
||||
{{% 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]
|
||||
128
content/en/docs/components/physical-envs/lxc.md
Normal file
128
content/en/docs/components/physical-envs/lxc.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
title: "LXC"
|
||||
linkTitle: "LXC"
|
||||
weight: 30
|
||||
description: >
|
||||
Linux Containers for lightweight system-level virtualization
|
||||
---
|
||||
|
||||
{{% 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]
|
||||
128
content/en/docs/components/physical-envs/provider.md
Normal file
128
content/en/docs/components/physical-envs/provider.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
---
|
||||
title: "Infrastructure Provider"
|
||||
linkTitle: "Provider"
|
||||
weight: 40
|
||||
description: >
|
||||
Infrastructure provider abstraction for managing physical resources
|
||||
---
|
||||
|
||||
{{% 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]
|
||||
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 62 KiB |
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Getting Started"
|
||||
linkTitle: "Getting Started"
|
||||
weight: 3
|
||||
weight: 20
|
||||
description: >
|
||||
Quick start guides and onboarding information for the Edge Developer Platform.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Governance"
|
||||
linkTitle: "Governance"
|
||||
weight: 5
|
||||
weight: 100
|
||||
description: >
|
||||
Project history, architecture decisions, compliance, and audit information.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Operations"
|
||||
linkTitle: "Operations"
|
||||
weight: 4
|
||||
weight: 40
|
||||
description: >
|
||||
Operational guides for deploying, monitoring, and maintaining the Edge Developer Platform.
|
||||
---
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: "Platform Overview"
|
||||
linkTitle: "Platform Overview"
|
||||
weight: 1
|
||||
weight: 10
|
||||
description: >
|
||||
High-level overview of the Edge Developer Platform (EDP), its purpose, and product structure.
|
||||
---
|
||||
|
|
|
|||
10
resources/edp-likec4/models/context/documentation.c4
Normal file
10
resources/edp-likec4/models/context/documentation.c4
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
model {
|
||||
documentation = system 'Documentation' {
|
||||
description 'Documentation system for EDP LikeC4 platform.'
|
||||
technology 'Static Site Generator'
|
||||
icon tech:electron
|
||||
-> edp 'provides documentation for'
|
||||
platformdeveloper -> documentation "creates and maintains documentation"
|
||||
|
||||
}
|
||||
}
|
||||
|
|
@ -1,336 +0,0 @@
|
|||
// Documentation Platform Architecture Model
|
||||
// This model describes the Hugo-based documentation platform
|
||||
|
||||
model {
|
||||
|
||||
// === Personas ===
|
||||
technicalWriter = person 'Technical Writer' {
|
||||
description 'Content creator and maintainer of the developer platform documentation'
|
||||
technology 'Hugo, Markdown, LikeC4'
|
||||
}
|
||||
|
||||
// === Documentation Platform System ===
|
||||
docPlatform = system 'Documentation Platform' {
|
||||
description 'Hugo-based documentation system with integrated architecture visualization'
|
||||
|
||||
// Core Components
|
||||
hugoSite = component 'Hugo Site' {
|
||||
description 'Static site generator based on Hugo with Docsy theme'
|
||||
technology 'Hugo Extended, Docsy'
|
||||
}
|
||||
|
||||
contentRepo = repository 'Content Repository' {
|
||||
description 'Markdown files, images, and configuration'
|
||||
technology 'Git, Markdown'
|
||||
|
||||
contentPages = component 'Content Pages' {
|
||||
description 'Documentation pages in Markdown format'
|
||||
technology 'Markdown'
|
||||
}
|
||||
|
||||
archModels = component 'Architecture Models' {
|
||||
description 'LikeC4 architecture models and views'
|
||||
technology 'LikeC4 DSL'
|
||||
}
|
||||
|
||||
assets = component 'Static Assets' {
|
||||
description 'CSS, JavaScript, images, fonts'
|
||||
technology 'CSS, JavaScript'
|
||||
}
|
||||
}
|
||||
|
||||
likec4Integration = component 'LikeC4 Integration' {
|
||||
description 'Architecture diagram visualization embedded in documentation'
|
||||
technology 'LikeC4, Web Components'
|
||||
}
|
||||
|
||||
// Build & Development Tools
|
||||
taskfile = tool 'Taskfile' {
|
||||
description 'Task automation for local development, build, and testing'
|
||||
technology 'Task (go-task)'
|
||||
}
|
||||
|
||||
devServer = process 'Development Server' {
|
||||
description 'Local Hugo server with hot reload for content development'
|
||||
technology 'Hugo Server'
|
||||
}
|
||||
}
|
||||
|
||||
// === CI/CD Pipeline ===
|
||||
cicdPipeline = system 'CI/CD Pipeline' {
|
||||
description 'Automated testing and deployment pipeline'
|
||||
|
||||
githubActions = process 'GitHub Actions' {
|
||||
description 'Automated testing workflow on push/PR'
|
||||
technology 'GitHub Actions'
|
||||
|
||||
testBuild = component 'Build Test' {
|
||||
description 'Hugo build validation'
|
||||
technology 'Hugo'
|
||||
}
|
||||
|
||||
testMarkdown = component 'Markdown Lint' {
|
||||
description 'Markdown syntax and style checking'
|
||||
technology 'markdownlint'
|
||||
}
|
||||
|
||||
testHtml = component 'HTML Validation' {
|
||||
description 'Generated HTML validation'
|
||||
technology 'htmlvalidate'
|
||||
}
|
||||
|
||||
testLinks = component 'Link Checker' {
|
||||
description 'Broken link detection'
|
||||
technology 'htmltest'
|
||||
}
|
||||
}
|
||||
|
||||
containerBuild = process 'Container Build' {
|
||||
description 'OCI/Docker image creation with Hugo site'
|
||||
technology 'Docker'
|
||||
}
|
||||
}
|
||||
|
||||
// === Deployment ===
|
||||
deploymentEnv = system 'Deployment Environment' {
|
||||
description 'Edge deployment infrastructure'
|
||||
|
||||
edgeConnect = system 'Edge Connect' {
|
||||
description 'Edge deployment orchestration platform'
|
||||
technology 'EdgeConnect'
|
||||
}
|
||||
|
||||
k8sCluster = system 'Kubernetes Cluster' {
|
||||
description 'K8s cluster on edge cloudlet (Munich)'
|
||||
technology 'Kubernetes'
|
||||
|
||||
docService = component 'Documentation Service' {
|
||||
description 'LoadBalancer service exposing docs on port 80'
|
||||
technology 'K8s Service'
|
||||
}
|
||||
|
||||
docDeployment = component 'Documentation Deployment' {
|
||||
description 'Pod running Hugo-generated static site'
|
||||
technology 'K8s Deployment, Nginx'
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// === Relationships: Technical Writer Workflow ===
|
||||
technicalWriter -> contentRepo.contentPages 'writes documentation' {
|
||||
description 'Creates and updates Markdown content'
|
||||
}
|
||||
|
||||
technicalWriter -> contentRepo.archModels 'creates architecture models' {
|
||||
description 'Defines C4 models with LikeC4 DSL'
|
||||
}
|
||||
|
||||
technicalWriter -> taskfile 'executes local tasks' {
|
||||
description 'task serve, task build, task test'
|
||||
}
|
||||
|
||||
// === Relationships: Local Development ===
|
||||
taskfile -> devServer 'starts' {
|
||||
description 'task serve'
|
||||
}
|
||||
|
||||
devServer -> hugoSite 'renders' {
|
||||
description 'Live reload on content changes'
|
||||
}
|
||||
|
||||
hugoSite -> contentRepo 'reads content from' {
|
||||
description 'Processes Markdown and templates'
|
||||
}
|
||||
|
||||
hugoSite -> likec4Integration 'integrates' {
|
||||
description 'Embeds architecture diagrams'
|
||||
}
|
||||
|
||||
likec4Integration -> contentRepo.archModels 'visualizes' {
|
||||
description 'Renders C4 models as interactive diagrams'
|
||||
}
|
||||
|
||||
// === Relationships: Testing ===
|
||||
taskfile -> githubActions.testBuild 'can run locally' {
|
||||
description 'task test:build'
|
||||
}
|
||||
|
||||
taskfile -> githubActions.testMarkdown 'can run locally' {
|
||||
description 'task test:markdown'
|
||||
}
|
||||
|
||||
taskfile -> githubActions.testHtml 'can run locally' {
|
||||
description 'task test:html'
|
||||
}
|
||||
|
||||
taskfile -> githubActions.testLinks 'can run locally' {
|
||||
description 'task test:links'
|
||||
}
|
||||
|
||||
// === Relationships: CI/CD ===
|
||||
contentRepo -> githubActions 'triggers on push/PR' {
|
||||
description 'Webhook on main branch'
|
||||
}
|
||||
|
||||
githubActions.testBuild -> hugoSite 'builds' {
|
||||
description 'hugo --gc --minify'
|
||||
}
|
||||
|
||||
githubActions.testMarkdown -> contentRepo.contentPages 'validates' {
|
||||
description 'Lints Markdown files'
|
||||
}
|
||||
|
||||
githubActions.testHtml -> hugoSite 'validates output' {
|
||||
description 'Checks generated HTML'
|
||||
}
|
||||
|
||||
githubActions.testLinks -> hugoSite 'checks links in' {
|
||||
description 'Detects broken links'
|
||||
}
|
||||
|
||||
githubActions -> containerBuild 'triggers on success' {
|
||||
description 'Builds Docker image with Hugo output'
|
||||
}
|
||||
|
||||
containerBuild -> hugoSite 'packages' {
|
||||
description 'public/ directory served by Nginx'
|
||||
}
|
||||
|
||||
// === Relationships: Deployment ===
|
||||
containerBuild -> deploymentEnv.edgeConnect 'pushes image to' {
|
||||
description 'Tagged container image'
|
||||
}
|
||||
|
||||
deploymentEnv.edgeConnect -> deploymentEnv.k8sCluster 'deploys to' {
|
||||
description 'Via edgeconnectdeployment.yaml'
|
||||
}
|
||||
|
||||
deploymentEnv.k8sCluster.docDeployment -> deploymentEnv.k8sCluster.docService 'exposed by' {
|
||||
description 'Port 80'
|
||||
}
|
||||
|
||||
technicalWriter -> deploymentEnv.k8sCluster.docService 'views published docs' {
|
||||
description 'HTTPS access to live documentation'
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
// === Views ===
|
||||
|
||||
views {
|
||||
|
||||
view overview of docPlatform {
|
||||
title 'Documentation Platform Overview'
|
||||
description 'High-level overview of the Hugo-based documentation platform for technicalWriters'
|
||||
|
||||
include *
|
||||
|
||||
style technicalWriter {
|
||||
color green
|
||||
}
|
||||
style docPlatform {
|
||||
color blue
|
||||
}
|
||||
}
|
||||
|
||||
view localDevelopment of docPlatform {
|
||||
title 'Local Development Workflow'
|
||||
description 'How a technicalWriter works locally with the documentation'
|
||||
|
||||
include technicalWriter
|
||||
include docPlatform
|
||||
include docPlatform.contentRepo -> *
|
||||
include docPlatform.hugoSite
|
||||
include docPlatform.likec4Integration
|
||||
include docPlatform.taskfile
|
||||
include docPlatform.devServer
|
||||
|
||||
style technicalWriter {
|
||||
color green
|
||||
}
|
||||
style docPlatform.taskfile {
|
||||
color amber
|
||||
}
|
||||
style docPlatform.devServer {
|
||||
color amber
|
||||
}
|
||||
}
|
||||
|
||||
view cicdPipeline of cicdPipeline {
|
||||
title 'CI/CD Pipeline'
|
||||
description 'Automated testing and container build process'
|
||||
|
||||
include cicdPipeline
|
||||
include cicdPipeline.githubActions -> *
|
||||
include cicdPipeline.containerBuild
|
||||
include docPlatform.contentRepo
|
||||
include docPlatform.hugoSite
|
||||
|
||||
style cicdPipeline.githubActions {
|
||||
color blue
|
||||
}
|
||||
style cicdPipeline.containerBuild {
|
||||
color indigo
|
||||
}
|
||||
}
|
||||
|
||||
view deploymentFlow {
|
||||
title 'Deployment to Edge Environment'
|
||||
description 'How the documentation is deployed to the edge infrastructure'
|
||||
|
||||
include cicdPipeline.containerBuild
|
||||
include deploymentEnv
|
||||
include deploymentEnv.edgeConnect
|
||||
include deploymentEnv.k8sCluster -> *
|
||||
include technicalWriter
|
||||
|
||||
style deploymentEnv {
|
||||
color muted
|
||||
}
|
||||
style deploymentEnv.k8sCluster {
|
||||
color secondary
|
||||
}
|
||||
}
|
||||
|
||||
view fullWorkflow {
|
||||
title 'Complete Technical Writer Workflow'
|
||||
description 'End-to-end view from content creation to published documentation'
|
||||
|
||||
include technicalWriter
|
||||
include docPlatform.contentRepo
|
||||
include docPlatform.taskfile
|
||||
include cicdPipeline.githubActions
|
||||
include cicdPipeline.containerBuild
|
||||
include deploymentEnv.edgeConnect
|
||||
include deploymentEnv.k8sCluster
|
||||
|
||||
style technicalWriter {
|
||||
color green
|
||||
}
|
||||
style docPlatform.taskfile {
|
||||
color amber
|
||||
}
|
||||
style cicdPipeline.githubActions {
|
||||
color blue
|
||||
}
|
||||
style deploymentEnv.k8sCluster {
|
||||
color secondary
|
||||
}
|
||||
}
|
||||
|
||||
view testingCapabilities of cicdPipeline.githubActions {
|
||||
title 'Testing Capabilities'
|
||||
description 'All automated tests that ensure documentation quality'
|
||||
|
||||
include *
|
||||
include docPlatform.hugoSite
|
||||
include docPlatform.contentRepo.contentPages
|
||||
include docPlatform.taskfile
|
||||
|
||||
style cicdPipeline.githubActions {
|
||||
color blue
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
views {
|
||||
view components-template-documentation of documentation {
|
||||
description 'Documentation System Context View'
|
||||
include documentation
|
||||
include platformdeveloper with {
|
||||
title 'Technical Writer'
|
||||
description 'Could be an engineer, but in this case it\'s the Technical Writer'
|
||||
}
|
||||
// autoLayout LeftRight 120 110
|
||||
}
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Loading…
Add table
Add a link
Reference in a new issue