From 86073cee7dadaabcbc7f820ae9352a7f77edd1be Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Mon, 17 Nov 2025 08:51:44 +0100 Subject: [PATCH] docs(components): refactored component picture and added the documenttaion system itself --- .vscode/settings.json | 21 +------------------ content/en/docs/components/_index.md | 19 +++++++++++++++++ ...umentation_resources_product-structure.svg | 4 ++-- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 6212e98..0436b04 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,22 +1,3 @@ { - "peacock.remoteColor": "#61dafb", - "workbench.colorCustomizations": { - "activityBar.activeBackground": "#93e6fc", - "activityBar.background": "#93e6fc", - "activityBar.foreground": "#15202b", - "activityBar.inactiveForeground": "#15202b99", - "activityBarBadge.background": "#fa45d4", - "activityBarBadge.foreground": "#15202b", - "commandCenter.border": "#15202b99", - "sash.hoverBorder": "#93e6fc", - "statusBar.background": "#61dafb", - "statusBar.foreground": "#15202b", - "statusBarItem.hoverBackground": "#2fcefa", - "statusBarItem.remoteBackground": "#61dafb", - "statusBarItem.remoteForeground": "#15202b", - "titleBar.activeBackground": "#61dafb", - "titleBar.activeForeground": "#15202b", - "titleBar.inactiveBackground": "#61dafb99", - "titleBar.inactiveForeground": "#15202b99" - } + "peacock.remoteColor": "#61dafb" } \ No newline at end of file diff --git a/content/en/docs/components/_index.md b/content/en/docs/components/_index.md index 99f1955..d93f56b 100644 --- a/content/en/docs/components/_index.md +++ b/content/en/docs/components/_index.md @@ -6,6 +6,20 @@ description: > Overview of EDP platform components and their integration. --- +{{% alert title="Draft" color="warning" %}} +**Editorial Status**: This page is currently being developed. + +* **Jira Ticket**: [TICKET-XXX](https://your-jira/browse/TICKET-XXX) +* **Assignee**: Stephan +* **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 %}} + This section documents all components of the Edge Developer Platform based on the product structure. ## Component Categories @@ -18,4 +32,9 @@ The EDP consists of the following main component categories: * **Dev Environments**: Development environment provisioning * **Physical Environments**: Runtime infrastructure + +### Product Component Structure + +[TODO] Links + ![alt text](website-and-documentation_resources_product-structure.svg) \ No newline at end of file diff --git a/content/en/docs/components/website-and-documentation_resources_product-structure.svg b/content/en/docs/components/website-and-documentation_resources_product-structure.svg index 75b48aa..007788f 100644 --- a/content/en/docs/components/website-and-documentation_resources_product-structure.svg +++ b/content/en/docs/components/website-and-documentation_resources_product-structure.svg @@ -1,2 +1,2 @@ -EDPForgejoOrchestratorInfrastructure-Provisioninginfra-deploy, infra-cataloguePlatform-ProvisioningStacksComponent 1Component ....project-mgmtActionsRunnerRunner-OrchestrationDeploymentsOTCEdgeConnectEdgeConnectClientProviderDevEnvironmentsPhysicalEnvsDockerKubernetesLXCeDF Product Structure Tree \ No newline at end of file +EDPForgejoOrchestrationInfrastructure-ProvisioningTerraforminfra-deploy,infra-cataloguePlatform-ProvisioningStacksComponent 1Component ....Project-mgmtActionsRunnerRunner-OrchestrationDeploymentsOTCEdgeConnectEdgeConnectClientProviderDevEnvironmentsPhysicalEnvsDockerKubernetesLXCeDF Product Structure TreeDocumentationSystem \ No newline at end of file