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

Improve clarity of content type feature param documentation strings #344

Merged
merged 1 commit into from
Apr 28, 2021
Merged

Improve clarity of content type feature param documentation strings #344

merged 1 commit into from
Apr 28, 2021

Conversation

wbclark
Copy link
Contributor

@wbclark wbclark commented Apr 22, 2021

This is based on #343

I can rebase once that is merged if it is needed

@wbclark wbclark changed the title Content plugin docs Improve clarity of content plugin param documentation strings Apr 22, 2021
@wbclark wbclark force-pushed the content_plugin_docs branch from 4fbc143 to d232adc Compare April 23, 2021 15:52
@wbclark
Copy link
Contributor Author

wbclark commented Apr 23, 2021

Rebased

ekohl
ekohl requested changes Apr 23, 2021
View reviewed changes
manifests/init.pp Outdated Show resolved Hide resolved
manifests/init.pp Outdated Show resolved Hide resolved
manifests/init.pp Outdated Show resolved Hide resolved
manifests/init.pp Outdated Show resolved Hide resolved
@ehelms
Copy link
Member

ehelms commented Apr 23, 2021

Instead of sync and serve, consider manage as you can are enabling the content to do a lot more than just sync and serve it.

@wbclark
Copy link
Contributor Author

wbclark commented Apr 23, 2021

Instead of sync and serve, consider manage as you can are enabling the content to do a lot more than just sync and serve it.

I am torn because manage might be more technically correct, but I think the specificity of sync and serve is probably clearer and more immediately intuitive to a larger set of users.

I think I prefer either sync and serve or maybe sync, manage, and serve for that reason. What do you think @ehelms ?

@wbclark wbclark force-pushed the content_plugin_docs branch from d232adc to 17c8a2d Compare April 23, 2021 18:11
@wbclark
Copy link
Contributor Author

wbclark commented Apr 23, 2021

Thanks for the suggestions @ekohl . I've made the update based on your recommendations.

I kept the sync and serve language for now. Definitely open to further discussion on that.

ehelms
ehelms reviewed Apr 26, 2021
View reviewed changes
manifests/init.pp Outdated Show resolved Hide resolved
@wbclark wbclark force-pushed the content_plugin_docs branch from 17c8a2d to dd216c8 Compare April 26, 2021 19:38
@wbclark wbclark requested review from ekohl and ehelms April 26, 2021 19:45
ekohl
ekohl reviewed Apr 28, 2021
View reviewed changes
manifests/init.pp Outdated Show resolved Hide resolved
@wbclark wbclark force-pushed the content_plugin_docs branch 2 times, most recently from 5d0a13d to 3dad2bf Compare April 28, 2021 15:28
@wbclark wbclark changed the title Improve clarity of content plugin param documentation strings Improve clarity of content type feature param documentation strings Apr 28, 2021
ekohl
ekohl approved these changes Apr 28, 2021
View reviewed changes
Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

Other than the typo, 👍

manifests/init.pp Outdated Show resolved Hide resolved
@wbclark wbclark force-pushed the content_plugin_docs branch from 3dad2bf to e1c6c99 Compare April 28, 2021 15:37
@wbclark wbclark merged commit 4c54bbc into theforeman:master Apr 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ekohl ekohl ekohl approved these changes

@ehelms ehelms Awaiting requested review from ehelms

Assignees
No one assigned
Labels
Enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@wbclark @ehelms @ekohl @theforeman-bot