Skip to content

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
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

@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.

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants