eclipse-tractusx · paullatzelsperger · Sep 21, 2023 · Jul 17, 2023 · Jul 17, 2023 · Jul 17, 2023
diff --git a/.github/workflows/publish-docusaurus.yaml b/.github/workflows/publish-docusaurus.yaml
@@ -0,0 +1,68 @@
+#
+#  Copyright (c) 2023 Mercedes Benz Tech Innovation GmbH
+#  Copyright (c) 2021, 2023 Contributors to the Eclipse Foundation
+#
+#  See the NOTICE file(s) distributed with this work for additional
+#  information regarding copyright ownership.
+#
+#  This program and the accompanying materials are made available under the
+#  terms of the Apache License, Version 2.0 which is available at
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#  License for the specific language governing permissions and limitations
+#  under the License.
+#
+#  SPDX-License-Identifier: Apache-2.0
+#
+
+---
+name: "Publish docusaurus documentation"
+
+on:
+  workflow_dispatch:
+    inputs:
+      downstream-version:
+        required: false
+        type: string
+  workflow_call:
+    inputs:
+      downstream-version:
+        required: false
+        type: string
+
+jobs:
+  publish-docusaurus:
+    permissions:
+      contents: write
+      packages: write
+    name: "Publish docusaurus documentation as zip file"
+    runs-on: ubuntu-latest
+    env:
+      SWAGGERHUB_API_KEY: ${{ secrets.SWAGGERHUB_API_KEY }}
+      SWAGGERHUB_USER: ${{ secrets.SWAGGERHUB_USER }}
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: "Extract version"
+        id: extract_version
+        run: |
+          if [ -z ${{ inputs.downstream-version }} ]; then
+            echo "DOWNSTREAM_VERSION=$(grep "version" gradle.properties  | awk -F= '{print $2}')" >> "$GITHUB_OUTPUT"
+          else
+            echo "DOWNSTREAM_VERSION=${{ inputs.downstream-version }}" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: "Gather documentation files"
+        run: |
+          chmod +x ./resources/create_kit_documentation.sh
+          ./resources/create_kit_documentation.sh ${{ runner.temp }} $(pwd) ${{ steps.extract_version.outputs.DOWNSTREAM_VERSION }}
+
+      - name: Publish zip to GitHub Release
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: ${{ runner.temp }}/tractusx-edc-docusaurus-${{ steps.extract_version.outputs.DOWNSTREAM_VERSION }}.zip
+          tag: ${{ steps.extract_version.outputs.DOWNSTREAM_VERSION }}
diff --git a/.github/workflows/publish-new-release.yml b/.github/workflows/publish-new-release.yml
@@ -249,3 +249,14 @@ jobs:
     with:
       downstream-version: ${{ needs.release-version.outputs.RELEASE_VERSION }}
     secrets: inherit
+
+  publish-docusaurus:
+    name: Publish docusaurus docs
+    permissions:
+      contents: write
+      packages: write
+    needs: [ secret-presence, publish-to-swaggerhub, github-release ]
+    with:
+      downstream-version: ${{ needs.release-version.outputs.RELEASE_VERSION }}
+    uses: ./.github/workflows/publish-docusaurus.yaml
+    secrets: inherit
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -137,4 +137,11 @@ jobs:
     needs: [ secret-presence ]
     if: needs.secret-presence.outputs.HAS_SWAGGER
     uses: ./.github/workflows/publish-swaggerhub.yaml
-    secrets: inherit
+
+  publish-docusaurus:
+    name: Publish docusaurus docs
+    permissions:
+      contents: read
+    needs: [ secret-presence, publish-to-swaggerhub ]
+    if: needs.secret-presence.outputs.HAS_SWAGGER
+    uses: ./.github/workflows/publish-docusaurus.yaml
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -1,4 +1,6 @@
 # Copyright (c) 2023 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
+# Copyright (c) 2023 Mercedes-Benz Tech Innovation GmbH
+# Copyright (c) 2023 Contributors to the Eclipse Foundation
 #
 # See the NOTICE file(s) distributed with this work for additional
 # information regarding copyright ownership.
@@ -19,7 +21,14 @@
 "default": true
 # Do not restrict line length: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#MD013
 "MD013": false
-"MD034":
+# Do not restrict inline HTML: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#MD033
+"MD033": false
 # Allow same content on headlines on siblings: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#MD024
 "MD024":
   "siblings_only": true
+"MD032": false
+# Allow lists without empty lines around them: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#MD032
+# Necessary for Helm docs
+"MD004": false
+# Allow for more unordered lists: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#MD004
+# Necessary for Helm docs
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -49,7 +49,7 @@ This Code applies within all Project, Working Group, and Interest Group spaces a
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Conduct Committee via [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Without the explicit consent of the reporter, the Conduct Committee is obligated to maintain confidentiality with regard to the reporter of an incident. The Conduct Committee is further obligated to ensure that the respondent is provided with sufficient information about the complaint to reply. If such details cannot be provided while maintaining confidentiality, the Conduct Committee will take the respondent‘s inability to provide a defense into account in its deliberations and decisions. Further details of enforcement guidelines may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Conduct Committee via <[email protected]>. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Without the explicit consent of the reporter, the Conduct Committee is obligated to maintain confidentiality with regard to the reporter of an incident. The Conduct Committee is further obligated to ensure that the respondent is provided with sufficient information about the complaint to reply. If such details cannot be provided while maintaining confidentiality, the Conduct Committee will take the respondent‘s inability to provide a defense into account in its deliberations and decisions. Further details of enforcement guidelines may be posted separately.
 
 Staff, Committers and Project Leads have the right to report, remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code, or to block temporarily or permanently any Contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. Any such actions will be reported to the Conduct Committee for transparency and record keeping.
 

diff --git a/core/edr-core/README.md b/core/edr-core/README.md
@@ -1,4 +1,4 @@
-# EDR core extension
+# EDR Core Extension
 
 This extension provide a base implementation of `EdrManager` and `EdrService` both
 required for interacting with the EDR APIs and state machine

diff --git a/docs/development/Release.md b/docs/development/Release.md
@@ -38,11 +38,5 @@ The Eclipse Bot is able to approve dependencies automatically, if the license ca
    from maven central.
 2. Create the Eclipse IP Issues or ask an Eclipse Commiter to do this for you.
 
-## 4. Update OpenAPI docs
-
-As part of the [kits documentation provided for docusaurus](../kit/development-view/page00_development_view.md) we provide an OpenAPI reference.
-This refers to the [EDC API](https://github.com/eclipse-edc/Connector/tree/main/resources/openapi) and needs to be updated to the current release.
-The yaml files found there are then converted with the [docusaurus openapi plugin](https://www.npmjs.com/package/docusaurus-plugin-openapi-docs).
-
 [maven-shield]: https://img.shields.io/badge/Apache%20Maven-URL-blue
 [maven-url]: https://maven.apache.org
diff --git a/docs/development/postman/README.md b/docs/development/postman/README.md
@@ -23,7 +23,5 @@ The postman collection contains the most common API calls. Please note that the
 - Policy & Negotiation calls come in pairs for the different kinds of policies
 - the 'Data' call only works when using the All-In-One Deployment of this repository
 
-![screenshot](./images/screenshot.png)
-
 [postman-shield]: https://img.shields.io/badge/Postman-URL-orange
 [postman-url]: https://www.postman.com
diff --git a/docs/kit/adoption-view/page_adoption-view.md → docs/kit/Adoption View/00_adoption-view.md b/docs/kit/adoption-view/page_adoption-view.md → docs/kit/Adoption View/00_adoption-view.md
@@ -1,9 +1,4 @@
----
-id: Adoption View
-title: Adoption View
-description: 'Connector Kit'
-sidebar_position: 1
----
+# Adoption View
 
 The ConnectorKit provides a connector framework, based on the [Eclipse Dataspace Connector][edc-url] for sovereign, cross-enterprise data exchange.
 

diff --git a/...adoption-view/images/edc_architecture.png → ...Adoption View/images/edc_architecture.png b/...adoption-view/images/edc_architecture.png → ...Adoption View/images/edc_architecture.png
diff --git a/...kit/adoption-view/images/edc_overview.png → ...kit/Adoption View/images/edc_overview.png b/...kit/adoption-view/images/edc_overview.png → ...kit/Adoption View/images/edc_overview.png
diff --git a/docs/kit/adoption-view/page_domain_model.md → docs/kit/Development View/01_domain_model.md b/docs/kit/adoption-view/page_domain_model.md → docs/kit/Development View/01_domain_model.md
@@ -1,9 +1,4 @@
----
-id: Domain Model
-title: Domain Model
-description: 'Connector Kit'
-sidebar_position: 2
----
+# Domain Model
 
 ![domain-model](images/domain-model.png)
 

diff --git a/docs/kit/Development View/02_OpenAPI/00_open_api.md b/docs/kit/Development View/02_OpenAPI/00_open_api.md
@@ -0,0 +1,3 @@
+# OpenAPI
+
+The following is an automatically generated OpenAPI spec for the TractusX EDC.
diff --git a/docs/kit/operation-view/page10_extensions.md → ...t View/05_EDC Extensions/00_extensions.md b/docs/kit/operation-view/page10_extensions.md → ...t View/05_EDC Extensions/00_extensions.md
@@ -1,4 +1,4 @@
-# EDC Extensions
+# EDC Extensions Overview
 
 The following extensions provide additional functionality to the core EDC.
 They are currently only available in Tractus-X EDC.

diff --git a/...kit/adoption-view/images/domain-model.png → .../Development View/images/domain-model.png b/...kit/adoption-view/images/domain-model.png → .../Development View/images/domain-model.png
diff --git a/...pment-view/page02_repository_structure.md → .../Documentation/00_repository_structure.md b/...pment-view/page02_repository_structure.md → .../Documentation/00_repository_structure.md
diff --git a/...elopment-view/page03_project_structure.md → ...kit/Documentation/01_project_structure.md b/...elopment-view/page03_project_structure.md → ...kit/Documentation/01_project_structure.md
diff --git a/...t/operation-view/page00_operation_view.md → docs/kit/Operation View/00_operation_view.md b/...t/operation-view/page00_operation_view.md → docs/kit/Operation View/00_operation_view.md
diff --git a/...on-view/page02_technical_prerequisites.md → ...ration View/01_technical_prerequisites.md b/...on-view/page02_technical_prerequisites.md → ...ration View/01_technical_prerequisites.md
diff --git a/...n-view/page03_local_setup_controlplane.md → ...ocal Setup/00_local_setup_controlplane.md b/...n-view/page03_local_setup_controlplane.md → ...ocal Setup/00_local_setup_controlplane.md
diff --git a/...tion-view/page04_local_setup_dataplane.md → ...2_Local Setup/01_local_setup_dataplane.md b/...tion-view/page04_local_setup_dataplane.md → ...2_Local Setup/01_local_setup_dataplane.md
diff --git a/docs/kit/operation-view/page08_api.md → ...eration View/04_Test Your Setup/01_api.md b/docs/kit/operation-view/page08_api.md → ...eration View/04_Test Your Setup/01_api.md
@@ -3,7 +3,7 @@
 ## API Spec
 
 The API spec of the EDC is constantly evolving.
-The full API documentation for each release can be viewed on [management-api](../development-view/openAPI/management-api/management-api.info.mdx).
+The full API documentation for each release can be viewed on [management-api](../Development View/02_OpenAPI/management-api/management-api.info.mdx).
 The following are some example API calls for common use cases.
 They assume the default parameters from the previous local setup.
 

diff --git a/docs/kit/operation-view/page09_upgrading.md → ...eration View/05_Migration/00_upgrading.md b/docs/kit/operation-view/page09_upgrading.md → ...eration View/05_Migration/00_upgrading.md
diff --git a/docs/kit/development-view/page00_development_view.md b/docs/kit/development-view/page00_development_view.md
diff --git a/docs/kit/development-view/page01_eclipse_foundation.md b/docs/kit/development-view/page01_eclipse_foundation.md
diff --git a/docs/kit/operation-view/page06_kubernetes_setup.md b/docs/kit/operation-view/page06_kubernetes_setup.md
diff --git a/docs/migration/Version_0.4.x_0.5.x.md b/docs/migration/Version_0.4.x_0.5.x.md
@@ -59,8 +59,8 @@ out [this documentation](https://github.com/eclipse-tractusx/tractusx-edc/blob/m
 
 If you are using the MIW and KeyCloak instances deployed to `INT`, the following values apply:
 
-- MIW Url: https://managed-identity-wallets-new.int.demo.catena-x.net
-- KeyCloak Token URL: https://centralidp.int.demo.catena-x.net/auth/realms/CX-Central/protocol/openid-connect/token
+- MIW Url: <https://managed-identity-wallets-new.int.demo.catena-x.net>
+- KeyCloak Token URL: <https://centralidp.int.demo.catena-x.net/auth/realms/CX-Central/protocol/openid-connect/token>
 - Authority BPN: `BPNL00000003CRHK`
 
 > Please be aware that the above values are *only* valid for the Catena-X INT environment and *will* change on other

diff --git a/edc-controlplane/edc-controlplane-memory-hashicorp-vault/notice.md b/edc-controlplane/edc-controlplane-memory-hashicorp-vault/notice.md
@@ -2,24 +2,24 @@
 
 An EDC Control Plane using memory-based storage, and HashiCorp Vault as secret store.
 
-DockerHub: https://hub.docker.com/r/tractusx/edc-controlplane-memory-hashicorp-vault
+DockerHub: <https://hub.docker.com/r/tractusx/edc-controlplane-memory-hashicorp-vault>
 
 Eclipse Tractus-X product(s) installed within the image:
 
 ## Tractus-X-EDC Control Plane
 
-- GitHub: https://github.com/eclipse-tractusx/tractusx-edc
-- Project home: https://projects.eclipse.org/projects/automotive.tractusx
-- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-controlplane/edc-controlplane-memory-hashicorp-vault/src/main/docker/Dockerfile
+- GitHub: <https://github.com/eclipse-tractusx/tractusx-edc>
+- Project home: <https://projects.eclipse.org/projects/automotive.tractusx>
+- Dockerfile: <https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-controlplane/edc-controlplane-memory-hashicorp-vault/src/main/docker/Dockerfile>
 - Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE)
 
 ## Used base image
 
 - [eclipse-temurin:17.0.8_7-jre-alpine](https://github.com/adoptium/containers)
-- Official Eclipse Temurin DockerHub page: https://hub.docker.com/_/eclipse-temurin
-- Eclipse Temurin Project: https://projects.eclipse.org/projects/adoptium.temurin
+- Official Eclipse Temurin DockerHub page: <https://hub.docker.com/_/eclipse-temurin>
+- Eclipse Temurin Project: <https://projects.eclipse.org/projects/adoptium.temurin>
 - Additional information about the Eclipse Temurin
-  images: https://github.com/docker-library/repo-info/tree/master/repos/eclipse-temurin
+  images: <https://github.com/docker-library/repo-info/tree/master/repos/eclipse-temurin>
 
 As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc
 from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

diff --git a/edc-controlplane/edc-controlplane-postgresql-azure-vault/README.md b/edc-controlplane/edc-controlplane-postgresql-azure-vault/README.md
@@ -1,4 +1,6 @@
-# EDC Control-Plane backed by [Postgresql](https://www.postgresql.org/)
+# EDC Control-Plane PostgreSQL & Azure Key Vault
+
+This verison of the EDC Control-Plane is backed by [PostgreSQL](https://www.postgresql.org/) and [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/#product-overview).
 
 ## Building
 

diff --git a/edc-controlplane/edc-controlplane-postgresql-azure-vault/notice.md b/edc-controlplane/edc-controlplane-postgresql-azure-vault/notice.md
@@ -2,24 +2,24 @@
 
 An EDC Control Plane using PostgreSQL as persistence backend, and Azure KeyVault as secret store.
 
-DockerHub: https://hub.docker.com/r/tractusx/edc-controlplane-postgresql-azure-vault
+DockerHub: <https://hub.docker.com/r/tractusx/edc-controlplane-postgresql-azure-vault>
 
 Eclipse Tractus-X product(s) installed within the image:
 
 ## Tractus-X EDC Control Plane
 
-- GitHub: https://github.com/eclipse-tractusx/tractusx-edc
-- Project home: https://projects.eclipse.org/projects/automotive.tractusx
-- Dockerfile: https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-controlplane/edc-controlplane-postgresql-azure-vault/src/main/docker/Dockerfile
+- GitHub: <https://github.com/eclipse-tractusx/tractusx-edc>
+- Project home: <https://projects.eclipse.org/projects/automotive.tractusx>
+- Dockerfile: <https://github.com/eclipse-tractusx/tractusx-edc/blob/main/edc-controlplane/edc-controlplane-postgresql-azure-vault/src/main/docker/Dockerfile>
 - Project license: [Apache License, Version 2.0](https://github.com/eclipse-tractusx/tractusx-edc/blob/main/LICENSE)
 
 ## Used base image
 
 - [eclipse-temurin:17.0.8_7-jre-alpine](https://github.com/adoptium/containers)
-- Official Eclipse Temurin DockerHub page: https://hub.docker.com/_/eclipse-temurin
-- Eclipse Temurin Project: https://projects.eclipse.org/projects/adoptium.temurin
+- Official Eclipse Temurin DockerHub page: <https://hub.docker.com/_/eclipse-temurin>
+- Eclipse Temurin Project: <https://projects.eclipse.org/projects/adoptium.temurin>
 - Additional information about the Eclipse Temurin
-  images: https://github.com/docker-library/repo-info/tree/master/repos/eclipse-temurin
+  images: <https://github.com/docker-library/repo-info/tree/master/repos/eclipse-temurin>
 
 As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc
 from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

diff --git a/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md b/edc-controlplane/edc-controlplane-postgresql-hashicorp-vault/README.md
@@ -1,4 +1,6 @@
-# EDC Control-Plane backed by [Postgresql](https://www.postgresql.org/) and [HashiCorp vault](https://www.vaultproject.io/docs)
+# EDC Control-Plane PostgreSQL & Hashicorp Vault
+
+This version of the EDC Control-Plane is backed by [PostgreSQL](https://www.postgresql.org/) and [HashiCorp Vault](https://www.vaultproject.io/docs).
 
 ## Building
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# OpenAPI

		The following is an automatically generated OpenAPI spec for the TractusX EDC.