Uploaded image for project: 'MusicBrainz Server'
  1. MusicBrainz Server
  2. MBS-5772

Generate relationship documentation (semi-)automatically

    XMLWordPrintable

    Details

      Description

      The problem:
      We store all of our relationship type documentation in the wiki.
      There are over 100 of these pages.
      This documentation largely (but not entirely) duplicates what we already store in the database.
      The wiki pages use a template which breaks easily but the template is so bad that nobody dares try to fix it.
      The wiki pages are out of date and need updating.
      Because of the above (number of pages, amount of duplication, that damn template), most of the relationship type pages have still not been updated for NGS almost two years after it was released.

      What I'd like to do is generate the pages automatically from data in the database so that it can easily kept in sync. However, to be able to do that, we need to be able to store guidelines and examples with the relationship types as well.

      There's a couple of other potential advantages:
      It would also become easier to translate (simply add the columns to the list of things extracted for translation).
      It would also be possible to embed guidelines and/or examples inline in editing pages if we wanted to.

        Attachments

          Issue Links

          There are no Sub-Tasks for this issue.

            Activity

              People

              • Assignee:
                acid2 Oliver Charles
                Reporter:
                nikki nikki
              • Votes:
                3 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Packages

                  Version Package
                  Schema change, 2013-05-15