Opened 5 years ago

Last modified 3 years ago

#947 accepted enhancement

Media type configuration options are not documented

Reported by: Matt Molyneaux Owned by:
Priority: trivial Milestone:
Component: documentation Keywords:
Cc: Parent Tickets:

Description

Enabling the various media types is well documented, however no hint is given on how to configure media specific options, e.g. video quality.

There are individual config_spec.ini files scattered around, but there's no mention of where to put those options in mediagoblin_local.ini.

Subtickets

Attachments (1)

0001-Fix-947-media_type-configuration-files-location.patch (1.2 KB) - added by Loic Dachary 4 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 5 years ago by Matt Molyneaux

Probably related to #734

comment:2 Changed 4 years ago by Loic Dachary

Status: newreview

comment:3 Changed 4 years ago by Loic Dachary

The proposed fix really is a workaround. The better way to do it would be to have a page similar what is expected from plugins ( see http://mediagoblin.readthedocs.org/en/latest/plugindocs/flatpagesfile.html#flatpagesfile-chapter for instance ).

comment:4 Changed 4 years ago by Christopher Allan Webber

Merged your patch, thank you! I'm leaving this open though, since I agree this is not optimal... I have some thoughts... letting them collect before I write them here.

comment:5 Changed 4 years ago by Christopher Allan Webber

So right now config_spec.ini is kind of nice in that it provides default values, does proper type conversion in the config files, and leaves us a place to leave comments on what the config values mean.

Of course, looking at a config specification that is itself a config file is not exactly a nice place to find out how things work! And the file is not exactly nice to read anyway. What we *really* want is a place that has the above features but is also self-documenting. We should be able to type information on what a variable does and not have to repeat it in the documentation, similar to how we can pull docstrings from python into our Sphinx documentation.

So here's my suggestion: we replace config_spec.ini with config_spec.hy, and have our own super-minimal configuration specification DSL written in Hy. Most of the same parameters for the specification can remain the same, but then we can also add a "description" field, which could be extracted and read by our Sphinx docs.

What do people think of this?

comment:6 Changed 4 years ago by Matt Molyneaux

As long as Hy supports all the same Python versions as GMG does, I see no reason not to.

comment:7 Changed 3 years ago by Boris Bobrov

Status: reviewaccepted
Note: See TracTickets for help on using tickets.