From 930159ce62264d69ca12e900a5d9346e30968045 Mon Sep 17 00:00:00 2001 From: Stephan Lo Date: Mon, 16 Dec 2024 22:15:02 +0100 Subject: [PATCH] refactor(edp-poc): moved local development code and poc documentation design in respective folders --- README_wip.md => design/README-poc-design.md | 0 .../content-and-storybook.png | Bin use-cases.png => design/use-cases.png | Bin .../user_documentation.md | 0 .../README-backstage-local.md | 0 edp-backstage-integration/catalog-info.yaml | 21 ++++++++++++++++++ .../devbox.json | 0 mkdocs.yml | 4 ++++ 8 files changed, 25 insertions(+) rename README_wip.md => design/README-poc-design.md (100%) rename content-and-storybook.png => design/content-and-storybook.png (100%) rename use-cases.png => design/use-cases.png (100%) rename user_documentation.md => docs/user_documentation.md (100%) rename README-backstage-local.md => edp-backstage-integration/README-backstage-local.md (100%) create mode 100644 edp-backstage-integration/catalog-info.yaml rename devbox.json => edp-backstage-integration/devbox.json (100%) create mode 100644 mkdocs.yml diff --git a/README_wip.md b/design/README-poc-design.md similarity index 100% rename from README_wip.md rename to design/README-poc-design.md diff --git a/content-and-storybook.png b/design/content-and-storybook.png similarity index 100% rename from content-and-storybook.png rename to design/content-and-storybook.png diff --git a/use-cases.png b/design/use-cases.png similarity index 100% rename from use-cases.png rename to design/use-cases.png diff --git a/user_documentation.md b/docs/user_documentation.md similarity index 100% rename from user_documentation.md rename to docs/user_documentation.md diff --git a/README-backstage-local.md b/edp-backstage-integration/README-backstage-local.md similarity index 100% rename from README-backstage-local.md rename to edp-backstage-integration/README-backstage-local.md diff --git a/edp-backstage-integration/catalog-info.yaml b/edp-backstage-integration/catalog-info.yaml new file mode 100644 index 0000000..a06354e --- /dev/null +++ b/edp-backstage-integration/catalog-info.yaml @@ -0,0 +1,21 @@ +apiVersion: backstage.io/v1alpha1 +kind: Component +metadata: + namespace: edppoc + name: documentation + description: This component represents the documentation for our project. + annotations: + backstage.io/techdocs-ref: dir:.. + tags: + - documentation + - docs +spec: + type: documentation + owner: team-name + lifecycle: active + providesApis: + - documentation-api + consumesApis: + - other-api + dependsOn: + - resource:other-component \ No newline at end of file diff --git a/devbox.json b/edp-backstage-integration/devbox.json similarity index 100% rename from devbox.json rename to edp-backstage-integration/devbox.json diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..acf004f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,4 @@ +site_name: Documentation Site +docs_dir: docs +plugins: + - techdocs-core