Data Governance KIT Documentation

[dg-tsy]

Description

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

• DEPENDENCIES are up-to-date. Dash license tool. Committers can open IP issues for restricted libs.
• Copyright and license header are present on all affected files

[maximilianong]

Overall:

Sidebar navigation: link to KIT is missing
Please integrate swagger hub link in sidebar navigation
Example from certificate management KIT:

Changelog:

Changelog version needs to be changed to 0.1.0
Change date to 08.03

Operation View:

Is this really needed?
Will there be a reference implementation provided in the future?

Suggestion:
Renaming from development view to archtictecture view - example from Traceability https://eclipse-tractusx.github.io/docs-kits/next/kits/Traceability%20Kit/Architecture%20View%20Traceability%20Kit

[dg-tsy]

@maximilianong Here is the reply to your feedback comments:

• sidebar navigation for Data Governance Kit added.
• I could not find "Certificate Management Kit" anywhere. Could you please guide me to its correct path?
• Changelog is now updated.
• I thought that "Oparation View" was mandatory. When it's not mandatory, I can remove it in next iteration.
  There will be no reference implementation.
• If I rename the development view to architecture view, then would I have an architecture view in addition to development view? If not, then where would the API specifications come? I propose to either keep it as it is or add two separate views architecture and development view. Please suggest.

I am still struggling about how to make "kits/Data Governance Kit/resources/openAPI.yaml" as a Tractus-X SwaggerHub API documentation. Any help in this regard is much appreciated.

[maximilianong]

Please fix the requested changes by 04.03.2024 (EOB) so that we can perform the final checks and prepare the release communication.

@dg-tsy we sent out the following explanation - please make sure you are on the Eclipse mailing list:

For APIs with reference implementation:

Please use (or adapt existing) automated workflows to publish on SwaggerHub. Maintain your openAPI.yaml and the publishing workflow in the repository of the reference implementation. Remove everything related to that from the website repo and only link to SwaggerHub in your KIT from now on.
We utilize a user provided by the Eclipse Foundation to publish on SwaggerHub.
Credentials for this user can be used through the eclipse-tractusx GitHub org secrets and can be utilized in automated workflows.
Pay special attention to the "swaggerHub" CLI commands.
The location where the openAPI file is maintained may vary. The BPDM example showcases how the application is initiated to download and publish the current file from that location.

  SWAGGERHUB_API_KEY: ${{ secrets.SWAGGERHUB_API_KEY }}
  SWAGGERHUB_USER: ${{ secrets.SWAGGERHUB_USER }}

Examples:
BPDM Certificate Management: [https://github.com/eclipse-tractusx/bpdm-certificate-management/blob/main/.github/workflows/publish-swagger-hub.yaml]

If you have any questions, please use the office hour:
https://eclipse-tractusx.github.io/community/open-meetings

[maximilianong]

Operation view: not mandatory if you do not have something to operate :D please remove it with this PR.

Regarding your suggestion for development view - its ok to go with your approach.

[danielmiehle]

@dg-tsy can you also fix your current linting issues, please?

[dg-tsy]

@maximilianong Following tasks completed:

• Operations View removed, also removed its references from /sidebarsDocsKits.js
• Linting issues resolved
• Added .mdx files for API details, hence changes suggested in this comment should not be required.

Please let me know if anything else is required. Looks like all changes done from my side.

[dg-tsy]

@maximilianong
Could you please let me know if there are any open topics for me to work upon? Many thanks in advance.