README.md includes out-of-date description of the config.yaml options

Bug #1260735 reported by Brad Crittenden
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
mongodb (Juju Charms Collection)
Fix Released
Undecided
Charles Butler

Bug Description

The README.me file contains a description of the config values that are prone to getting out of date as changes are made to the definitive config.yam.

Since the config.yaml is shown in Charmworld at http://manage.jujucharms.com/charms/precise/mongodb it is redundant and problematic to include in the README also.

If we do want to maintain the list in two places, this bug should address it being out of sync because new variables were added to config.yaml and I neglected to update the README.

Jorge Castro (jorge)
Changed in mongodb (Juju Charms Collection):
assignee: nobody → Jorge O. Castro (jorge)
status: New → In Progress
Changed in mongodb (Juju Charms Collection):
assignee: Jorge O. Castro (jorge) → Charles Butler (lazypower)
Revision history for this message
Charles Butler (lazypower) wrote :

The latest version of the charm store somewhat addresses this by listing out the configuration options directly in the charm service overview

https://jujucharms.com/mongodb/

Do we feel that its prudent to remove the listing from the README, or prune it down to common configuration patterns?

Revision history for this message
Charles Butler (lazypower) wrote :

This was addressed by a prior commit, the bug is now outdated. Closing as fix released since the README links directly to the new jujucharms.com listing of the config options.

Changed in mongodb (Juju Charms Collection):
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.