eclipse-tractusx · Phil91 · Nov 19, 2024 · Nov 19, 2024 · Nov 19, 2024 · Nov 19, 2024
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ dotnet run
 
 ## Known Issues and Limitations
 
-See [Known Knowns](/docs/technical-documentation/known-knowns/known-issues-and-limitations.md).
+See [Known Knowns](/docs/admin/known-issues-and-limitations.md).
 
 ## Notice for Docker image
 

diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,20 @@
+# Introduction
+
+This repository provides the backend code for the SSI Credential Issuer.
+
+The following table links you to the respective documentations.
+
+| Documentation                                                     | Purpose                                                                           |
+| ----------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| [Arc42](architecture/Index.md)                                    | Architecture Documentation for the SSI Credential Issuer.                         |
+| [How to contribute](./admin/dev-process/How%20to%20contribute.md) | Information relevant, if you contribute in the SSI Credential Issuer development. |
+| [Administration Guide](admin/Admin_Guide.md)                      | Information relevant, if you want to use the SSI Credential Issuer application.   |
+| [API Documentation](api/API_Doc.md)                               | Information about the endpoints.                                                  |
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/ssi-credential-issuer
diff --git a/docs/admin/Admin_Guide.md b/docs/admin/Admin_Guide.md
@@ -0,0 +1,14 @@
+# Admin Guide
+
+## Getting started
+
+To start the application refer to the [Installation Guide](../../charts/ssi-credential-issuer/README.md).
+It provides information on deployment via helm.
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/ssi-credential-issuer
diff --git a/...on/dev-process/Dev-flow_deploy-dev-env.md → ...in/dev-process/Dev-flow_deploy-dev-env.md b/...on/dev-process/Dev-flow_deploy-dev-env.md → ...in/dev-process/Dev-flow_deploy-dev-env.md
diff --git a/...ation/dev-process/Dev-flow_git-diagram.md → ...admin/dev-process/Dev-flow_git-diagram.md b/...ation/dev-process/Dev-flow_git-diagram.md → ...admin/dev-process/Dev-flow_git-diagram.md
diff --git a/...ation/dev-process/Enumeration Handling.md → ...admin/dev-process/Enumeration Handling.md b/...ation/dev-process/Enumeration Handling.md → ...admin/dev-process/Enumeration Handling.md
diff --git a/...entation/dev-process/How to contribute.md → docs/admin/dev-process/How to contribute.md b/...entation/dev-process/How to contribute.md → docs/admin/dev-process/How to contribute.md
diff --git a/...wn-knowns/known-issues-and-limitations.md → docs/admin/known-issues-and-limitations.md b/...wn-knowns/known-issues-and-limitations.md → docs/admin/known-issues-and-limitations.md
diff --git a/...tial-creation/initial-credential-setup.md → ...tial-creation/initial-credential-setup.md b/...tial-creation/initial-credential-setup.md → ...tial-creation/initial-credential-setup.md
diff --git a/...tation/release-process/Release Process.md → .../admin/release-process/Release Process.md b/...tation/release-process/Release Process.md → .../admin/release-process/Release Process.md
diff --git a/docs/api/API_Doc.md b/docs/api/API_Doc.md
@@ -0,0 +1,19 @@
+# API Documentation
+
+This document provides information on the endpoints.
+
+## OpenAPI Specifications
+
+There is an [OpenAPI 3.0.1 specification document](./issuer-service.yaml) available.
+
+## Postman
+
+There is a [postman collection](./postman) containing information on how to work with the api.
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/ssi-credential-issuer
diff --git a/...ialIssuer.Service.postman_collection.json → ...ialIssuer.Service.postman_collection.json b/...ialIssuer.Service.postman_collection.json → ...ialIssuer.Service.postman_collection.json
diff --git a/.../architecture/Architecture Constraints.md → ...chitecture/02_architecture_constraints.md b/.../architecture/Architecture Constraints.md → ...chitecture/02_architecture_constraints.md
diff --git a/docs/architecture/Context and scope.md → ...chitecture/03_system_scope_and_context.md b/docs/architecture/Context and scope.md → ...chitecture/03_system_scope_and_context.md
@@ -1,4 +1,4 @@
-# Content and Scope
+# System Context and Scope
 
 ## Business Context
 

diff --git a/docs/architecture/Solution strategy.md → docs/architecture/04_solution_strategy.md b/docs/architecture/Solution strategy.md → docs/architecture/04_solution_strategy.md
diff --git a/docs/architecture/Whitebox Overall System.md → docs/architecture/05_building_block_view.md b/docs/architecture/Whitebox Overall System.md → docs/architecture/05_building_block_view.md
@@ -1,4 +1,4 @@
-# Whitebox Overall System
+# Building Block View
 
 ## Summary
 

diff --git a/docs/architecture/operational-concept.md → ...architecture/08_01_operational_concept.md b/docs/architecture/operational-concept.md → ...architecture/08_01_operational_concept.md
diff --git a/docs/architecture/Development Concept.md → ...architecture/08_02_development_concept.md b/docs/architecture/Development Concept.md → ...architecture/08_02_development_concept.md
diff --git a/docs/architecture/Security_Assessment.md → docs/architecture/08_03_security_concept.md b/docs/architecture/Security_Assessment.md → docs/architecture/08_03_security_concept.md
diff --git a/docs/architecture/08_concepts.md b/docs/architecture/08_concepts.md
@@ -0,0 +1,15 @@
+# Cross-cutting Concepts
+
+## Table of Content
+
+- [Operational concepts](./08_01_operational_concept.md)
+- [Developer concepts](./08_02_development_concept.md)
+- [Security Concept](./08_03_security_concept.md)
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/ssi-credential-issuer
diff --git a/docs/architecture/Requirements.md → docs/architecture/10_quality_requirements.md b/docs/architecture/Requirements.md → docs/architecture/10_quality_requirements.md
diff --git a/docs/architecture/Index.md b/docs/architecture/Index.md
@@ -0,0 +1,20 @@
+# Arc42
+
+This documentation follows the arc42 template to provide a comprehensive overview of the SSI Credential Issuer.
+
+## Table of Content
+
+- [02. Architecture Constraints](./02_architecture_constraints.md)
+- [03. Context and Scope](./03_system_scope_and_context.md)
+- [04. Solution Strategy](./04_solution_strategy.md)
+- [05. Building Block View](./05_building_block_view.md)
+- [08. Concepts](./08_concepts.md)
+- [10. Quality Requirements](./10_quality_requirements.md)
+
+## NOTICE
+
+This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0).
+
+- SPDX-License-Identifier: Apache-2.0
+- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
+- Source URL: https://github.com/eclipse-tractusx/ssi-credential-issuer
diff --git a/docs/database/auditing.md → docs/architecture/database/auditing.md b/docs/database/auditing.md → docs/architecture/database/auditing.md
diff --git a/docs/database/db-view.md → docs/architecture/database/db-view.md b/docs/database/db-view.md → docs/architecture/database/db-view.md
diff --git a/docs/database/seeding.md → docs/architecture/database/seeding.md b/docs/database/seeding.md → docs/architecture/database/seeding.md