SAP-docs / btp-cloud-platform

Markdown source for the SAP BTP documentation. Enables feedback and contributions to improve the documentation.
Creative Commons Attribution 4.0 International
50 stars 95 forks source link

Feedback for "Parameters and Properties" #129

Closed piejanssens closed 1 year ago

piejanssens commented 1 year ago

https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/490c8f71e2b74bc0a59302cada66117c.html

Each tool publishes a list of system parameters

What is a 'tool'? Where do we find all system parameters per tool? Please complete the list of system/generic/read-only parameters.

As you can see, I'm not sure what to call them... 😉 I must say that I'm not a fan of the term 'parameter' in this context... IMO, the term deployer variable would be more meaningful.

Some "system parameters" that are missing from the documentation here:

There are probably others, so it would be useful to get the full list in the documentation.

Related: https://github.com/SAP/cloud-mta-build-tool/issues/1005

nikolasimeonov77 commented 1 year ago

Thank you for your feedback! We’ll look into it and come back to you if we have any questions.

lilyanarangelova commented 1 year ago

Hi, Thank you for your feedback! I'll forward it to my colleague who is responsible for this documentation.

Best regards, Lilyana

boyan-velinov commented 1 year ago

@piejanssens Thanks for the feedback!

The page Parameters and Properties can be improved by making it more focused on MTA deployment in BTP Cloud Foundry environment. We need to remove all abstract statements like referred one:

Each tool publishes a list of system parameters..

Other points for improvements:

I agree that Parameter and Properties are not clear thems, but they came from MTA specificiation: https://www.sap.com/documents/2021/09/66d96898-fa7d-0010-bca6-c68f7e60039b.html

The MTA specification have various implementation on MTA deployment side for different environments, like BTP Cloud Foundry, BTP Neo and HANA XSA. It has implementations on MTA design time like MTA build tool, WebIDE Full Stack. MTA specification is used also from other tools that are not included in MTA parsing and processing. I am saying all of this because we will keep the term as it is in order to comply with MTA specification and all other related tools/scenarios.

For sure, we will think about of making it more clear for what Parameters are used.

As a reference for the mentioned parameters:

lilyanarangelova commented 1 year ago

The documentation has been updated