Opened 11 years ago

Last modified 7 years ago

#734 accepted enhancement

Document the config options available in config_spec.ini

Reported by: rodney757 Owned by:
Priority: major Milestone:
Component: documentation Keywords: bitesized
Cc: Parent Tickets:


It would be nice if we had all of the config options documented in one place.

Change History (6)

comment:1 by Emily O'Leary, 11 years ago

Status: newaccepted

There is a piece of semi-complete documentation in /mediagoblin/mediagoblin/config_spec.ini.

It would just need more comments as to document each option.

comment:2 by Christopher Allan Webber, 11 years ago


comment:3 by Christopher Allan Webber, 11 years ago

Keywords: bitesized added

A really simple solution to this: symlink config_spec.ini into the mediagoblin docs' static directoy. Then link to it in the docs somewhere relevant!

comment:4 by Christopher Allan Webber, 10 years ago


comment:5 by Christopher Allan Webber, 10 years ago

Milestone: 0.7.0

comment:6 by Jorge, 7 years ago

This looks resolved to me.

from docs/source/siteadmin/configuration.rst

There's one more file that you certainly won't change unless you're
making coding contributions to mediagoblin, but which can be useful to
read and reference:

  This file is actually a specification for mediagoblin.ini itself, as
  a config file!  It defines types and defaults.  Sometimes it's a
  good place to look for documentation... or to find that hidden
  option that we didn't tell you about. :)
Note: See TracTickets for help on using tickets.