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

Minor reorganization and cleanup of config #1385

Merged
merged 2 commits into from Nov 7, 2018
Merged

Minor reorganization and cleanup of config #1385

merged 2 commits into from Nov 7, 2018

Conversation

cdibella
Copy link
Contributor

--- Provide a general summary of your changes in the Title above -->

Description

I added a few more section headers and moved/grouped some of the like things together. I didn't touch most of what was in the first "most frequently changed" section, except for an occasional typo or clarity cleanup.

When additional configuration options are added, they should be added to the appropriate section or have a new section heading if they're not part of an existing topical area. As much as possible, each option in the config file should have an explanatory comment or example.

Related JIRA Ticket or GitHub Issue

Motivation and Context

Many options for the application and its administration can be controlled through the config file, but the file itself is somewhat confusing to navigate. This is a first step toward cleaning it up a bit.

Further work, including breaking this long file up into multiple files or enabling more to be changed via the frontend interface, may be warranted, but for now I was just aiming to make it a little easier for a user to work through the config file its current format.

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Added some more comments and did some topic-based organization
@gwiedeman
Copy link
Contributor

@lmcglohon I'm not sure why tests failed with "Artifacts support disabled for pull requests." It failed for me locally as well, but I don't really know why. It runs fine for me and all the changes in the config file appear to be superficial. Is there a reason not to merge this?

@lmcglohon
Copy link
Contributor

@gwiedeman There should be no reason not to merge this. I am currently working on other test failures, so feel free to merge this if you think it is good to go.

@gwiedeman gwiedeman merged commit a8ca334 into master Nov 7, 2018
@lmcglohon lmcglohon deleted the configChanges branch November 8, 2018 20:43
@lmcglohon lmcglohon modified the milestones: 2.5.2-candidate, 2.5.2 Nov 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants