Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add user manual for Management API #951

Closed
arnoweiss opened this issue Dec 20, 2023 · 0 comments · Fixed by #953
Closed

docs: add user manual for Management API #951

arnoweiss opened this issue Dec 20, 2023 · 0 comments · Fixed by #953
Assignees
Labels
enhancement New feature or request triage all new issues awaiting classification

Comments

@arnoweiss
Copy link
Contributor

WHAT

Currently, the "docs/kit" folder contains outdated docs. However, documentation on using the tractusx-edc service is sparse. Thus, there should be a management

WHY

Documenation on how to integrate the tractusx-edc service via the Management API is outdated but required by application developers who want to expose their APIs to the dataspace.

HOW

Rename docs/kit section to docs/manual and add updated management API walkthrough that currently lives here and is set to be updated. Content from the PR to the deployed Connector-Kit may provide initial content for the rework.

FURTHER NOTES

There was a discussion in the matrix-channel about this as well. Having the Management-API-Walkthrough here was suggested by @ndr-brt.

Please be sure to take a look at
our contribution guidelines and
our PR etiquette.

@arnoweiss arnoweiss added enhancement New feature or request triage all new issues awaiting classification labels Dec 20, 2023
@arnoweiss arnoweiss self-assigned this Dec 20, 2023
@arnoweiss arnoweiss moved this from Open to In Progress in EDC Board Dec 20, 2023
@arnoweiss arnoweiss moved this from In Progress to In Review in EDC Board Jan 8, 2024
@github-project-automation github-project-automation bot moved this from In Review to Done in EDC Board Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage all new issues awaiting classification
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant