diff --git a/README.md b/README.md index 43cb4aa..9038b2b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ -# 🌟 eDF Release 'PoC' +# 🌟 EdgeDeveloperPlatform - EDP Release 'PoC' + +Telekom MMS & T-Systems, December 2024 > **Tagline:** Change the way we work with IDP's. --- +This file describes how you can read the EDP documentation and run and use the platform. + ## 📋 Table of Contents - [🌟 eDF Release 'PoC'](#-edf-release-poc) diff --git a/docs/.gitignore b/docs/about/license.md similarity index 100% rename from docs/.gitignore rename to docs/about/license.md diff --git a/docs/about/mkdocs-test.md b/docs/about/mkdocs-test.md new file mode 100644 index 0000000..aef2ddd --- /dev/null +++ b/docs/about/mkdocs-test.md @@ -0,0 +1,133 @@ +# Mkdoc Test Doc + +```plantuml +@startuml +title Login Sequence + ComponentA->ComponentB: Login Request + note right of ComponentB: ComponentB logs message + ComponentB->ComponentA: Login Response +@enduml +``` + +## hello mock docs + +!!! test +Testing something + +Abbreviations: +Some text about MOCDOC + +This is a paragraph. +{: #test_id .test_class } + +Apple +: Pomaceous fruit of plants of the genus Malus in +the family Rosaceae. + +```javascript +import { test } from 'something'; + +const addThingToThing = (a, b) a + b; +``` + +- [abc](#abc) +- [xyz](#xyz) + +## abc + +This is a b c. + +## xyz + +This is x y z. + +# The attack plan + +{% dot attack_plan.svg + digraph G { + rankdir=LR + Earth [peripheries=2] + Mars + Earth -> Mars + } +%} + +```graphviz dot attack_plan.svg +digraph G { + rankdir=LR + Earth [peripheries=2] + Mars + Earth -> Mars +} +``` + +# PlantUML Samples + +```plantuml classes="uml myDiagram" alt="Diagram placeholder" title="My diagram" +@startuml + Goofy -> MickeyMouse: calls + Goofy <-- MickeyMouse: responds +@enduml +``` + +# Emojis + +:bulb: :smile: + +# Code blocks + +```javascript +import { test } from 'something'; + +const addThingToThing = (a, b) a + b; +``` + +# Grouped Code blocks + +=== "JavaScript" + + ```javascript + import { test } from 'something'; + + const addThingToThing = (a, b) a + b; + ``` + +=== "Java" + + ```java + public void function() { + test(); + } + ``` + +```java tab="java" + public void function() { + test(); + } +``` + +```java tab="java 2" + public void function() { + test(); + } +``` + +# MDX truly sane lists + +- attributes + +- customer + - first_name + - test + - family_name + - email +- person + - first_name + - family_name + - birth_date +- subscription_id + +- request + + +*[MOCDOC]: Mock Documentation diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/user_documentation.md b/docs/gettingstarted/user-documentation.md similarity index 100% rename from docs/user_documentation.md rename to docs/gettingstarted/user-documentation.md diff --git a/docs/index.md b/docs/index.md index f543c77..1e26380 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,133 +1,3 @@ -# Doc +# Getting Started -```plantuml -@startuml -title Login Sequence - ComponentA->ComponentB: Login Request - note right of ComponentB: ComponentB logs message - ComponentB->ComponentA: Login Response -@enduml -``` - -## hello mock docs - -!!! test -Testing something - -Abbreviations: -Some text about MOCDOC - -This is a paragraph. -{: #test_id .test_class } - -Apple -: Pomaceous fruit of plants of the genus Malus in -the family Rosaceae. - -```javascript -import { test } from 'something'; - -const addThingToThing = (a, b) a + b; -``` - -- [abc](#abc) -- [xyz](#xyz) - -## abc - -This is a b c. - -## xyz - -This is x y z. - -# The attack plan - -{% dot attack_plan.svg - digraph G { - rankdir=LR - Earth [peripheries=2] - Mars - Earth -> Mars - } -%} - -```graphviz dot attack_plan.svg -digraph G { - rankdir=LR - Earth [peripheries=2] - Mars - Earth -> Mars -} -``` - -# PlantUML Samples - -```plantuml classes="uml myDiagram" alt="Diagram placeholder" title="My diagram" -@startuml - Goofy -> MickeyMouse: calls - Goofy <-- MickeyMouse: responds -@enduml -``` - -# Emojis - -:bulb: :smile: - -# Code blocks - -```javascript -import { test } from 'something'; - -const addThingToThing = (a, b) a + b; -``` - -# Grouped Code blocks - -=== "JavaScript" - - ```javascript - import { test } from 'something'; - - const addThingToThing = (a, b) a + b; - ``` - -=== "Java" - - ```java - public void function() { - test(); - } - ``` - -```java tab="java" - public void function() { - test(); - } -``` - -```java tab="java 2" - public void function() { - test(); - } -``` - -# MDX truly sane lists - -- attributes - -- customer - - first_name - - test - - family_name - - email -- person - - first_name - - family_name - - birth_date -- subscription_id - -- request - - -*[MOCDOC]: Mock Documentation +Main entry point diff --git a/docs/ci_workflow.md b/docs/userguide/ci-workflow.md similarity index 100% rename from docs/ci_workflow.md rename to docs/userguide/ci-workflow.md diff --git a/docs/openbao.md b/docs/userguide/openbao.md similarity index 100% rename from docs/openbao.md rename to docs/userguide/openbao.md diff --git a/edp-backstage-integration/README-edp-backstage.md b/edp-backstage-integration/README-edp-backstage.md new file mode 100644 index 0000000..dad1187 --- /dev/null +++ b/edp-backstage-integration/README-edp-backstage.md @@ -0,0 +1,3 @@ +# Documenation in Backstage + +In a running Backstage import this catalog info. diff --git a/edp-backstage-integration/README-backstage-local.md b/live-preview-integration/README-backstage-local.md similarity index 100% rename from edp-backstage-integration/README-backstage-local.md rename to live-preview-integration/README-backstage-local.md diff --git a/edp-backstage-integration/devbox.json b/live-preview-integration/devbox.json similarity index 100% rename from edp-backstage-integration/devbox.json rename to live-preview-integration/devbox.json diff --git a/live-preview-integration/devbox.lock b/live-preview-integration/devbox.lock new file mode 100644 index 0000000..7f165db --- /dev/null +++ b/live-preview-integration/devbox.lock @@ -0,0 +1,118 @@ +{ + "lockfile_version": "1", + "packages": { + "nodejs@latest": { + "last_modified": "2024-11-22T01:27:12Z", + "plugin_version": "0.0.2", + "resolved": "github:NixOS/nixpkgs/8edf06bea5bcbee082df1b7369ff973b91618b8d#nodejs_23", + "source": "devbox-search", + "version": "23.2.0", + "systems": { + "aarch64-darwin": { + "outputs": [ + { + "name": "out", + "path": "/nix/store/xbz3pad3cn3kcm284k98mk1bdkjxdhcq-nodejs-23.2.0", + "default": true + }, + { + "name": "libv8", + "path": "/nix/store/grlg33az4h9dgqzb4hdz4xpydvspqlk1-nodejs-23.2.0-libv8" + } + ], + "store_path": "/nix/store/xbz3pad3cn3kcm284k98mk1bdkjxdhcq-nodejs-23.2.0" + }, + "aarch64-linux": { + "outputs": [ + { + "name": "out", + "path": "/nix/store/p4845y5infyxnscwq5xwwisv684gy3rh-nodejs-23.2.0", + "default": true + }, + { + "name": "libv8", + "path": "/nix/store/rvw0r6fbk8jr1gja8245ip31vkbjzdn8-nodejs-23.2.0-libv8" + } + ], + "store_path": "/nix/store/p4845y5infyxnscwq5xwwisv684gy3rh-nodejs-23.2.0" + }, + "x86_64-darwin": { + "outputs": [ + { + "name": "out", + "path": "/nix/store/arw5b6s4sl9af7zcvpjs41qnl24xi80x-nodejs-23.2.0", + "default": true + }, + { + "name": "libv8", + "path": "/nix/store/fbyf3510n96ph7liws525zx617jkcvf0-nodejs-23.2.0-libv8" + } + ], + "store_path": "/nix/store/arw5b6s4sl9af7zcvpjs41qnl24xi80x-nodejs-23.2.0" + }, + "x86_64-linux": { + "outputs": [ + { + "name": "out", + "path": "/nix/store/nsc1zfr2q3z2dp0c3vlip7lhkjckafk8-nodejs-23.2.0", + "default": true + }, + { + "name": "libv8", + "path": "/nix/store/v1j4ab0j2c8w3pk67p6lv8y19ika7rig-nodejs-23.2.0-libv8" + } + ], + "store_path": "/nix/store/nsc1zfr2q3z2dp0c3vlip7lhkjckafk8-nodejs-23.2.0" + } + } + }, + "yarn@latest": { + "last_modified": "2024-12-03T12:40:06Z", + "resolved": "github:NixOS/nixpkgs/566e53c2ad750c84f6d31f9ccb9d00f823165550#yarn", + "source": "devbox-search", + "version": "1.22.22", + "systems": { + "aarch64-darwin": { + "outputs": [ + { + "name": "out", + "path": "/nix/store/0hmmpszg5wfrr43kvlk2cxjqpll0dh2z-yarn-1.22.22", + "default": true + } + ], + "store_path": "/nix/store/0hmmpszg5wfrr43kvlk2cxjqpll0dh2z-yarn-1.22.22" + }, + "aarch64-linux": { + "outputs": [ + { + "name": "out", + "path": "/nix/store/vmx0di4y3m8amqwsfgyccf8zs8kml06q-yarn-1.22.22", + "default": true + } + ], + "store_path": "/nix/store/vmx0di4y3m8amqwsfgyccf8zs8kml06q-yarn-1.22.22" + }, + "x86_64-darwin": { + "outputs": [ + { + "name": "out", + "path": "/nix/store/nbaa0rip3xw6l3bmnc2k2fm071pzvzwv-yarn-1.22.22", + "default": true + } + ], + "store_path": "/nix/store/nbaa0rip3xw6l3bmnc2k2fm071pzvzwv-yarn-1.22.22" + }, + "x86_64-linux": { + "outputs": [ + { + "name": "out", + "path": "/nix/store/jcgdksj946l5l42c2y9ks2l4g6n74h3f-yarn-1.22.22", + "default": true + } + ], + "store_path": "/nix/store/jcgdksj946l5l42c2y9ks2l4g6n74h3f-yarn-1.22.22" + } + } + } + } +} diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index acf004f..0000000 --- a/mkdocs.yml +++ /dev/null @@ -1,4 +0,0 @@ -site_name: Documentation Site -docs_dir: docs -plugins: - - techdocs-core