diff --git a/README.md b/README.md index 10c0e210..18e269fd 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ For **information about the SSI Credential Issuer**, please refer to the documen For **installation** details, please refer to the [README.md](./charts/ssi-credential-issuer/README.md) of the provided helm chart. +To see the latest open API specs you can have a look at the [API Hub](https://eclipse-tractusx.github.io/api-hub/ssi-credential-issuer/). + ## How to build and run Install the [.NET 8.0 SDK](https://www.microsoft.com/net/download). @@ -25,7 +27,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 new file mode 100644 index 00000000..a658b8f7 --- /dev/null +++ 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) & [API Hub](https://eclipse-tractusx.github.io/api-hub/ssi-credential-issuer/) | 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 new file mode 100644 index 00000000..02693eca --- /dev/null +++ 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/docs/technical-documentation/dev-process/Dev-flow_deploy-dev-env.md b/docs/admin/dev-process/Dev-flow_deploy-dev-env.md similarity index 100% rename from docs/technical-documentation/dev-process/Dev-flow_deploy-dev-env.md rename to docs/admin/dev-process/Dev-flow_deploy-dev-env.md diff --git a/docs/technical-documentation/dev-process/Dev-flow_git-diagram.md b/docs/admin/dev-process/Dev-flow_git-diagram.md similarity index 100% rename from docs/technical-documentation/dev-process/Dev-flow_git-diagram.md rename to docs/admin/dev-process/Dev-flow_git-diagram.md diff --git a/docs/technical-documentation/dev-process/Enumeration Handling.md b/docs/admin/dev-process/Enumeration Handling.md similarity index 100% rename from docs/technical-documentation/dev-process/Enumeration Handling.md rename to docs/admin/dev-process/Enumeration Handling.md diff --git a/docs/technical-documentation/dev-process/How to contribute.md b/docs/admin/dev-process/How to contribute.md similarity index 100% rename from docs/technical-documentation/dev-process/How to contribute.md rename to docs/admin/dev-process/How to contribute.md diff --git a/docs/technical-documentation/known-knowns/known-issues-and-limitations.md b/docs/admin/known-issues-and-limitations.md similarity index 100% rename from docs/technical-documentation/known-knowns/known-issues-and-limitations.md rename to docs/admin/known-issues-and-limitations.md diff --git a/docs/technical-documentation/operator-credential-creation/initial-credential-setup.md b/docs/admin/operator-credential-creation/initial-credential-setup.md similarity index 100% rename from docs/technical-documentation/operator-credential-creation/initial-credential-setup.md rename to docs/admin/operator-credential-creation/initial-credential-setup.md diff --git a/docs/technical-documentation/release-process/Release Process.md b/docs/admin/release-process/Release Process.md similarity index 100% rename from docs/technical-documentation/release-process/Release Process.md rename to docs/admin/release-process/Release Process.md diff --git a/docs/api/API_Doc.md b/docs/api/API_Doc.md new file mode 100644 index 00000000..f1532f10 --- /dev/null +++ b/docs/api/API_Doc.md @@ -0,0 +1,23 @@ +# API Documentation + +This document provides information on the endpoints. + +## OpenAPI Specifications + +There is an [OpenAPI 3.0.1 specification document](./issuer-service.yaml) available. + +## API Hub + +To see the latest open API specs you can have a look at the [API Hub](https://eclipse-tractusx.github.io/api-hub/ssi-credential-issuer/). + +## 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 \ No newline at end of file diff --git a/docs/requests/Org.Eclipse.TractusX.SsiCredentialIssuer.Service.postman_collection.json b/docs/api/postman/Org.Eclipse.TractusX.SsiCredentialIssuer.Service.postman_collection.json similarity index 100% rename from docs/requests/Org.Eclipse.TractusX.SsiCredentialIssuer.Service.postman_collection.json rename to docs/api/postman/Org.Eclipse.TractusX.SsiCredentialIssuer.Service.postman_collection.json diff --git a/docs/architecture/Architecture Constraints.md b/docs/architecture/02_architecture_constraints.md similarity index 100% rename from docs/architecture/Architecture Constraints.md rename to docs/architecture/02_architecture_constraints.md diff --git a/docs/architecture/Context and scope.md b/docs/architecture/03_system_scope_and_context.md similarity index 98% rename from docs/architecture/Context and scope.md rename to docs/architecture/03_system_scope_and_context.md index 43e23b87..8c20b9a2 100644 --- a/docs/architecture/Context and scope.md +++ b/docs/architecture/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 b/docs/architecture/04_solution_strategy.md similarity index 100% rename from docs/architecture/Solution strategy.md rename to docs/architecture/04_solution_strategy.md diff --git a/docs/architecture/Whitebox Overall System.md b/docs/architecture/05_building_block_view.md similarity index 98% rename from docs/architecture/Whitebox Overall System.md rename to docs/architecture/05_building_block_view.md index a7b603b3..ff6dab68 100644 --- a/docs/architecture/Whitebox Overall System.md +++ b/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 b/docs/architecture/08_01_operational_concept.md similarity index 100% rename from docs/architecture/operational-concept.md rename to docs/architecture/08_01_operational_concept.md diff --git a/docs/architecture/Development Concept.md b/docs/architecture/08_02_development_concept.md similarity index 100% rename from docs/architecture/Development Concept.md rename to docs/architecture/08_02_development_concept.md diff --git a/docs/architecture/Security_Assessment.md b/docs/architecture/08_03_security_concept.md similarity index 100% rename from docs/architecture/Security_Assessment.md rename to docs/architecture/08_03_security_concept.md diff --git a/docs/architecture/08_concepts.md b/docs/architecture/08_concepts.md new file mode 100644 index 00000000..0fe8be46 --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/architecture/Requirements.md b/docs/architecture/10_quality_requirements.md similarity index 100% rename from docs/architecture/Requirements.md rename to docs/architecture/10_quality_requirements.md diff --git a/docs/architecture/Index.md b/docs/architecture/Index.md new file mode 100644 index 00000000..75db507d --- /dev/null +++ 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 \ No newline at end of file diff --git a/docs/database/auditing.md b/docs/architecture/database/auditing.md similarity index 100% rename from docs/database/auditing.md rename to docs/architecture/database/auditing.md diff --git a/docs/database/db-view.md b/docs/architecture/database/db-view.md similarity index 100% rename from docs/database/db-view.md rename to docs/architecture/database/db-view.md diff --git a/docs/database/seeding.md b/docs/architecture/database/seeding.md similarity index 100% rename from docs/database/seeding.md rename to docs/architecture/database/seeding.md