Giters

SAP-samples / btp-setup-automator

Automate the setup of your SAP BTP account with the SAP BTP CLI and other CLI tools.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[BUG] Documentation of parameters

lechnerc77 opened this issue · comments

commented

Is there an existing issue for this?

  • I have searched the existing issues

Are you using the latest docker image for BTPSA?

  • I'm using the latest docker image for BTPSA.

Which area is mainly impacted

Documentation

Current Behavior

The documentation of the parameters for the usecase.jsonand theparameters.json file are not easy to digest.
The information on what they do and how to use them is available in the JSON schemas and can be derived from the sample use case, but a markdown documentation is desirable.

This area needs to be improved in order to ease the adoption of the tool

Expected Behavior

Dedicated and consistent documentation on the parameters as a README file.

Steps To Reproduce

na

Logs and configuration files available?

na

Anything else?

No response

commented

To have a consistent documentation of the parameters:

  • JSON schema description (and templates) must be checked to contain a decent description and title for the parameters (where possible)
  • Generate documentation based on JSON schema (https://github.com/adobe/jsonschema2md)
  • Automate generation via GH Action (manual trigger, event based after fetching and generating JSON schema data)