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: Autodoc generation/preperation #700

Closed
4 tasks
stephanbcbauer opened this issue Aug 9, 2023 · 1 comment · Fixed by #808
Closed
4 tasks

docs: Autodoc generation/preperation #700

stephanbcbauer opened this issue Aug 9, 2023 · 1 comment · Fixed by #808
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@stephanbcbauer
Copy link
Member

stephanbcbauer commented Aug 9, 2023

Why

Since various properties in the different modules/extensions change or are added due to new functionality, it takes more time to document these manually at present. However, the description of the properties is necessary for developers and users of the EDC so that it can be configured and understood correctly.

Automatic generation of documentation is required for this purpose.

Note: @paullatzelsperger has already started with a poc, with the following functionality -> please contact him if you have further questions.

  • modules and dependencies are parsed recursive
  • in each file the parser loos for specific annotations which describe a property (description, default value…)
  • the information is extracted in a json file
  • the json file is transformed to a md file like this (just an example)
    tractusx-edc.md

What

  • Check the current status with @paullatzelsperger
  • Define a process for using this tools within a github workflow and generate the file automaticly
  • Document the process
  • Adapt the sourcecode (tractusx-edc) and add the needed annotations wherever it is needed and usefull
@stephanbcbauer stephanbcbauer added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 9, 2023
@github-project-automation github-project-automation bot moved this to Open in EDC Board Aug 9, 2023
@stephanbcbauer stephanbcbauer changed the title Template: Autodoc generation/preperation docs: Autodoc generation/preperation Aug 10, 2023
@ndr-brt ndr-brt self-assigned this Oct 5, 2023
@ndr-brt
Copy link
Contributor

ndr-brt commented Oct 5, 2023

Currently the autodoc misses to render the defaultValue attribute: eclipse-edc/GradlePlugins#184

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants