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

Fix MetricGardenerImporter Documentation #3039

Closed
6 tasks done
ce-bo opened this issue Sep 13, 2022 · 0 comments · Fixed by #3045
Closed
6 tasks done

Fix MetricGardenerImporter Documentation #3039

ce-bo opened this issue Sep 13, 2022 · 0 comments · Fixed by #3045
Assignees
Labels
bug Only issues that describe bugs. difficulty:low Solving this is likely not that difficult documentation pr-analysis Issues that touch the analysis pr(oject). priority:high Set by PO

Comments

@ce-bo
Copy link
Collaborator

ce-bo commented Sep 13, 2022

The MetricGardenerImporter Readme is not up to date.
Please adjust it to match the current parser.

Acceptance Criteria

  • There is a short introduction text to inform the user about that it can be used to parse files locally or to just import a given metric-gardener json file.
  • The info is fixed, so that it is not optional to compress files. Indeed it is the default behavior.
  • There is a link to the Documentation (GitHub Page) with a short hint that the user can find more information and usage examples there.
  • On the GitHub Page in the "Manual Mode" section, please note that metric-gardener command has to be installed before running npx metric-gardener parse /path/to/source/code -o mg_results.json by for example running npm i -g metric-gardener
  • Automatic mode (ccsh runs MetricGardener internally): is renamed to Create a CodeCharta json file from local source code (metric-gardener is executed internally on the fly):
  • Manual mode (run MetricGardener yourself): is renamed to Create a CodeCharta json file by importing a given metric-gardener json file (run MetricGardener yourself):
@ce-bo ce-bo added bug Only issues that describe bugs. pr-analysis Issues that touch the analysis pr(oject). documentation priority:high Set by PO difficulty:low Solving this is likely not that difficult labels Sep 13, 2022
@ce-bo ce-bo added this to the automation-basics-3 milestone Sep 13, 2022
@MW-Friedrich MW-Friedrich self-assigned this Sep 21, 2022
MW-Friedrich added a commit that referenced this issue Sep 21, 2022
MW-Friedrich added a commit that referenced this issue Sep 21, 2022
MW-Friedrich added a commit that referenced this issue Sep 21, 2022
* Update Documentation
#3039

* Update Changelog
#3039
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Only issues that describe bugs. difficulty:low Solving this is likely not that difficult documentation pr-analysis Issues that touch the analysis pr(oject). priority:high Set by PO
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants