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

Move documentation from the wiki to ReadTheDocs

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • None
    • None

      The wiki is not very modern and can be confusing for users (one reason being that it mixes documentation with user content/guides, as well as official and unofficial style guidelines).

      It has been suggested to move the documentation to ReadTheDocs, which is being used, with success, for MusicBrainz Picard and ListenBrainz.

      The initial items to discuss for this task are:

      • Do we want to move docs to ReadTheDocs
      • What and who is required for this to happen (in: ReadTheDocs, the wiki, MusicBrainz, other sites/projects/links)
      • What decisions need to be made
      • Who does what and when

      rdswift has created a proof of concept:
      https://github.com/rdswift/musicbrainz-docs
      https://musicbrainz-docs-development.readthedocs.io/en/latest/

        1. screenshot-2.png
          screenshot-2.png
          125 kB
        2. screenshot-1.png
          screenshot-1.png
          191 kB
        3. ReadtheDocs Styleguide.png
          ReadtheDocs Styleguide.png
          265 kB
        4. ReadtheDocs Documentation.png
          ReadtheDocs Documentation.png
          250 kB
        5. ReadtheDocs alternate sidebar.png
          ReadtheDocs alternate sidebar.png
          17 kB

            Unassigned Unassigned
            aerozol Aerozol
            Votes:
            1 Vote for this issue
            Watchers:
            7 Start watching this issue

              Created:
              Updated:

                Version Package