Opened 6 years ago

Last modified 2 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:

Description

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

Subtickets

Change History (6)

comment:1 Changed 5 years ago by Emily O'Leary

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 Changed 5 years ago by Christopher Allan Webber

Milestone: 0.5.00.6.0

comment:3 Changed 5 years ago by Christopher Allan Webber

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 Changed 5 years ago by Christopher Allan Webber

Milestone: 0.6.00.7.0

comment:5 Changed 5 years ago by Christopher Allan Webber

Milestone: 0.7.0

comment:6 Changed 2 years ago by Jorge

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:

mediagoblin/config_spec.ini
  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.