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.

Sign up for GitHub

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

Jump to bottom

Readme overhaul for all roles in collection #873

Merged
merged 3 commits into from
Oct 22, 2024
Merged

Readme overhaul for all roles in collection #873

merged 3 commits into from
Oct 22, 2024

Conversation

marcelmamula
Copy link
Contributor

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:

@marcelmamula marcelmamula added the documentation Improvements or additions to documentation label Sep 26, 2024
@marcelmamula marcelmamula self-assigned this Sep 26, 2024
kksat
kksat reviewed Sep 26, 2024
View reviewed changes
Copy link
Contributor

@kksat kksat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comments

README.md Show resolved Hide resolved
roles/sap_anydb_install_oracle/INPUT_PARAMETERS.md Outdated Show resolved Hide resolved
roles/sap_anydb_install_oracle/README.md Show resolved Hide resolved
roles/sap_general_preconfigure/README.md Show resolved Hide resolved
roles/sap_general_preconfigure/README.md Outdated Show resolved Hide resolved
@kksat
Copy link
Contributor

kksat commented Sep 26, 2024

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

#538

Worth looking into @marcelmamula

@marcelmamula
Copy link
Contributor Author

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.

berndfinger
berndfinger approved these changes Oct 21, 2024
View reviewed changes
Copy link
Member

@berndfinger berndfinger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@marcelmamula marcelmamula merged commit 348b2d2 into sap-linuxlab:dev Oct 22, 2024
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@berndfinger berndfinger berndfinger approved these changes

@ja9fuchs ja9fuchs Awaiting requested review from ja9fuchs

@kksat kksat Awaiting requested review from kksat

Assignees

@marcelmamula marcelmamula

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@marcelmamula @kksat @berndfinger