History:Restructuring The Documentation

The MusicBrainz Wiki Documentation Effort

• Status: This page has not been updated for quite a while. Work on this project has been merged into work on WikiDocs.

We have started wikifying the MusicBrainzDocumentation from the main pages, with the hope that the MusicBrainz community as a whole can contribute to improving the documentation (which needs updating and improvement in many ways) and also with the belief that the ease of intertwingling that Wiki provides will actually make it easier to improve the documentation.

• This documentation effort is CurrentWork as of November 2004. @alex

There is a very important RestructuringTheDocumentationDiscussion going on about how to do this, what the goals are etc. Please make sure to read and join this discussion before you join this project. Thanks. --DonRedman

The remainder of this page is

1. A list of pages that have been wikified, and their status.
2. A list of pages that have not yet been wikified and proposals on how to do it.

Documentation which has been wikified

The first batch of pages were just imported "as-is". Those pages still lack a StatusNotice at the top indicating where they were imported from, and what still needs to be done. You can find them [http:?back=OriginalVersion here]. If you have added a StatusNotice to a page, please list it below and replace the reference to "Original­Version" with something like "This is a wikified version ofthis static page" -- in this way Original­Version will eventually become obsolete. The notices should also have links like NeedsIntertwingling (or NeedsLinking), NeedsUpdating, BadWikiName, etc. so that they can be automatically linked here. See the RestructuringTheDocumentationDiscussion for more tips on adding a good StatusNotice.

Documentation listed by Wiki Name

List of documentation, ordered by WikiName.

• AdvancedSearch:

• Wikified, updated and extended to note the other searches and the PicardTagger. Still needs linking from other pages.

• ClientExamples:

• Seems up to date. DonRedman entered a lot of links but the whole page should probably be renamed to ClientLibraryExamples.

• Contribute:

• This page has been replaced by HowToContributeToMusicBrainz and will be deleted.

• DevelopmentToDoList:

• BadWikiName, What is the role of this page in MusicBrainzDevelopment? This is a partial duplicate FutureWork --DonRedman

• HelpWanted:

• Done by Paul

• HowMusicBrainzWorks:

• Needs Intertwingling with other general information about MusicBrainz badly.

• HowToContributeToMusicBrainz:

• Bad page with too much content taken out of context. The information itself is important but it should be presented in a short way with links to resources instead of one long page. --DonRedman

• As part of this restructuring the main page should be retitled HowToContribute. @alex

• MusicBrainz:

• Dupuy moved the introduction from the static pages to MusicBrainz. I suppose it could be made shorter and parts moved to IntroductionToMusicBrainz or something like that --DonRedman

Documentation listed by status

• Documentation that needs linking
• Documentation that Needs to be updated
• Documentation that needs restructuring into multiple wiki pages

Documentation which still needs wikification

I have started to add WikiName suggestions to this list. Feel free to comment and/or change them. I believe it is good practice to MakeLinksBeforeMakingPages. See RestructuringTheDocumentationDiscussion --DonRedman

• http://musicbrainz.org/information.html: (Maybe this should just be a list in the page MusicBrainz and then we could move part of MusicBrainz to IntroductionToMusicBrainz or WhatMusicBrainzIsAbout -DR)
• http://musicbrainz.org/future.html: (This needs a MetaBrainz page. I am not sure how good FutureOfMusicBrainz is. There will be a lot of discussion in the Wiki. We can put the latter in FutureOfMusicBrainzDiscussion or the former in OfficialFutureOfMusicBrainz :-) -DR) (Paul suggested GrandAmbitions, which i like very much -DR)
• http://musicbrainz.org/about/logos.html: MusicBrainzLogo
• http://musicbrainz.org/about/mirrors.html: (This is MusicBrainzMirror or MirrorServer and the more technical parts could be MirrorServerDocumentation or MirrorServerSetup -DR)
• http://musicbrainz.org/about/relatedprojects.html: (Currently this is more of a RelatedPrograms or OtherPrograms like OtherDatabases -DR)
• http://musicbrainz.org/news/licenses.html: (perhaps DataLicense -DR)
• http://musicbrainz.org/support/contact.html
• http://musicbrainz.org/index.html -- (just the middle column; not the sidebars)
• http://musicbrainz.org/todo.html -- (more or less moved already)
• http://musicbrainz.org/status.html -- (more or less moved already)
• http://musicbrainz.org/documentation.html
• http://musicbrainz.org/tagger/tutorial.html done, see ClassicTaggerTutorial --Keschte
• http://musicbrainz.org/tagger/download.html done, see ClassicTaggerDownload --Keschte
• http://musicbrainz.org/tagger/intro.html done, see ClassicTaggerQuickStart --Keschte
• http://musicbrainz.org/development/index.html done, see Development --Keschte
• http://musicbrainz.org/development/cvs.html done, see Subversion --Keschte
• http://musicbrainz.org/development/cvs-modules.html done, see Projects --Keschte
• http://musicbrainz.org/products/tunepimp/index.html done, see libtunepimp --Keschte
• http://musicbrainz.org/products/tunepimp/download.html done, see libtunepimpDownload --Keschte
• http://musicbrainz.org/docs/tunepimp/index.html {i} should be libtunepimpDevelopment --Keschte
• http://musicbrainz.org/products/server/docs/index.html done, see Server --Keschte
• http://musicbrainz.org/products/server/docs/20040215-1.html done, see ServerCodebase --Keschte
• http://musicbrainz.org/products/server/docs/20030820-1/index.html done, see DatabaseSchema --Keschte
• http://musicbrainz.org/db_structure.html done, see DatabaseSchema --Keschte
• http://musicbrainz.org/products/server/import_howto.html done, see DatabaseSetup --Keschte
• http://musicbrainz.org/download.html done, see Products --Keschte
• http://musicbrainz.org/products/cdlookup/download.html done, see CdLookupTool --Keschte
• http://musicbrainz.org/products/trmgen/download.html done, see TRMGen --Keschte
• http://musicbrainz.org/MM/index.html
• http://musicbrainz.org/MM/mm_examples.html
• http://musicbrainz.org/MM/mq_examples.html

Some others that perhaps don't make sense to convert are:

• http://musicbrainz.org/list.html
• http://musicbrainz.org/contract.html -- maybe not, for the same reasons as http://musicbrainz.org/privacy isn't in ModeratorPrivacy