Skip to content

Improve the description/help text... - #786

Merged
stejskalleos merged 1 commit into
theforeman:masterfrom
amolpati30:improve_text_for_log_level_parameter
Aug 31, 2026
Merged

Improve the description/help text...#786
stejskalleos merged 1 commit into
theforeman:masterfrom
amolpati30:improve_text_for_log_level_parameter

Conversation

@amolpati30

Copy link
Copy Markdown
Contributor

Improve the help text so that --help provides clear and accurate descriptions for the following parameters:

--log-level
--foreman-log-level
--foreman-proxy-log-level
--valkey-log-level
--pulp-log-level

Previously, the descriptions were not clear. They are now more precise and provide better information about the purpose and behavior of each parameter.

Comment thread docs/user/parameters.md Outdated
Comment thread src/playbooks/_logging/metadata.obsah.yaml Outdated
help: Name of the PAM service to use for IPA authentication
foreman_log_level:
help: Log level for Foreman. Defaults to the global log level.
help: Default log level for all services. unless overridden by the service-specific parameters.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
help: Default log level for all services. unless overridden by the service-specific parameters.
help: Default log level for all services, unless overridden by the service-specific parameters.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This line is not applicable to Foreman, so I added a different line that is applicable to Foreman.

Comment thread docs/user/parameters.md Outdated
Comment thread src/playbooks/_logging/metadata.obsah.yaml Outdated
Comment thread docs/user/parameters.md Outdated
Comment thread src/playbooks/_logging/metadata.obsah.yaml
Comment thread src/playbooks/_logging/metadata.obsah.yaml
Comment thread src/playbooks/_logging/metadata.obsah.yaml
help: Name of the PAM service to use for IPA authentication
foreman_log_level:
help: Log level for Foreman. Defaults to the global log level.
help: Default log level for all services. unless overridden by the service-specific parameters.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
help: Default log level for all services. unless overridden by the service-specific parameters.
help: Log level for Foreman. Default log level for all services. unless overridden by the service-specific parameters.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Same here; it is not required, as mentioned above.

--log-level
--foreman-log-level
--foreman-proxy-log-level
--valkey-log-level
--pulp-log-level
Comment thread src/playbooks/_logging/metadata.obsah.yaml
@stejskalleos
stejskalleos merged commit 5fb45b5 into theforeman:master Aug 31, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants