community.sap_install icon indicating copy to clipboard operation
community.sap_install copied to clipboard
verified publisher icon sap-linuxlab

Readme overhaul for all roles in collection

Open marcelmamula opened this issue 1 year ago • 2 comments

Reason:

Decision was made to overhaul Readme documents to:

  • Create common template for Collection and Roles readme documents
  • Remove outdated information
  • Move contents of Role Readme to Collection when possible (Required OS details, Python versions, etc.)
  • Create separate INPUT_PARAMETERS.md file with list of role input parameters
  • Add markdown blocks for future improvements

Scope:

  • Collection readme was updated
  • All roles were updated except sap_swpm which will be updated after https://github.com/sap-linuxlab/community.sap_install/pull/840

marcelmamula avatar Sep 26 '24 11:09 marcelmamula

Interesting discussion from about a year ago related (from my point of view to this PR)

https://github.com/sap-linuxlab/community.sap_install/discussions/538

Worth looking into @marcelmamula

kksat avatar Sep 26 '24 12:09 kksat

Interesting discussion from about a year ago related (from my point of view to this PR)

#538

Worth looking into @marcelmamula

Thank you, we are aware of it. This whole initiative is not just my effort.

I raised this change, but we all agreed on how to do it together.

marcelmamula avatar Sep 26 '24 13:09 marcelmamula