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.

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

Align configuration sample files #162

Open
eperott opened this issue Mar 27, 2020 · 0 comments
Open

Align configuration sample files #162

eperott opened this issue Mar 27, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@eperott
Copy link
Collaborator

eperott commented Mar 27, 2020

In the /conf directory of the repo we keep two sample files (one for the ecaudit plugin and one for the eclog tool). The sample configurations provide documentation of each configuration parameter.

But there are some annoying inconsistencies. Some examples simply set the default value. Sometimes these values are commented out, and sometimes not. In other cases we override the default to demonstrate how to use a specific config parameter. In some cases these overrided values are commented out, sometimes not.

Each and every example is created with good intentions and tries to convey some important information. However, when looking at the total, it is confusing.

I'd like us to settle on a consistent strategy. There are some (contradicting?) requirements to keep in mind when doing this:

  • The ecaudit plug-in and the eclog tool must be able to execute with their current default settings without the configuration files. Changing this would break backwards compatibility.
  • It would be nice if users could understand what the default settings are by just looking in the sample configuration file (not the code).
  • It would be nice if we don't have to maintain default settings in more than one place. If we repeat this information in more than one place, there will eventually be inconsistencies. To make the matter worse, default settings sometimes differ between flavors (for good reasons).
  • It would be nice if the sample configuration files could be used as-is without overriding default settings (useful if we start to provide rpm/deb packages at some point).
  • The documentation in the sample configuration files should clearly describe all settings, and all options for a setting.
  • The documentation in the sample configuration files should use a clear, consistent and crisp format.
@eperott eperott added the enhancement New feature or request label Mar 27, 2020
@eperott eperott mentioned this issue Mar 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant