Difference between revisions of "WikiDocs Page"

From MusicBrainz Wiki
(there is an existing page MusicBrainzPress, is the name ok? (Imported from MoinMoin))
(updated description texts (Imported from MoinMoin))
Line 1: Line 1:
 
=WikiDocs Pages=
 
=WikiDocs Pages=
  
[[Image:Attention.png]] ''This page lists all wiki pages that should be part of the initial [[WikiDocs]] launch and listed in the [[Moderated Revision Table|ModeratedRevisionTable]]''
+
[[Image:Attention.png]] This page lists all wiki pages that should be part of the initial [[WikiDocs]] launch and listed in the [[Wiki Transclusion|WikiTransclusion]] table.  
 
 
[[WikiDocs]] is curently live on the [[Test Server|TestServer]] only. The [http://test.musicbrainz.org/edit/wikitransclusion/transclusion.html Transclusion Table] will be migrated to the main server with the next release.  
 
  
 
==General Issues==
 
==General Issues==
  
To decide which pages nedd to be moderated I ask myself two questions:  
+
To decide which pages nedd to be added to the transclusion table I ask myself two questions:  
* What pages are relevant to a newcomer to [[MusicBrainz]]? These are the pages that should be moderated. Pages that are only relevant to people who are already accustomed to [[MusicBrainz]] can stay in the [[MusicBrainz Wiki|MusicBrainzWiki]] and do not need to be moderated, since a member of the [[MusicBrainz]] community can (or should learn to) retrieve informaiton from the wiki.  
+
* What pages are relevant to a newcomer to MusicBrainz? These are the pages that should be moderated. Pages that are only relevant to people who are already accustomed to MusicBrainz can stay in the MusicBrainzWiki and do not need to be moderated, since a member of the MusicBrainz community can (or should learn to) retrieve informaiton from the wiki.  
* What pages reflect an official position of the [[MusicBrainz]] project? The responsible persons need to have some control over these pages, thus they need to be moderated.  
+
* What pages reflect an official position of the MusicBrainz project? The responsible persons need to have some control over these pages, thus they need to be moderated.  
  
Generally I try to have as few pages in the [[Moderated Revision Table|ModeratedRevisionTable]] as possible. I think we should start out low. We can always add more pages later if we get problems with spammers and vandals. [[Moin Moin|MoinMoin]] has an [http://moinmoin.wikiwikiweb.de/AntiSpamGlobalSolution AntiSpamGlobalSolution] against the latter.  
+
Generally I try to have as few pages in the [[Wiki Transclusion|WikiTransclusion]] table as possible. I think we should start out low. We can always add more pages later if we get problems with spammers and vandals. [[Moin Moin|MoinMoin]] has an [http://moinmoin.wikiwikiweb.de/AntiSpamGlobalSolution AntiSpamGlobalSolution] against the latter.  
  
 
==Migration Guideline==
 
==Migration Guideline==
  
 
When converting an old static page into a [[WikiDocs]] page, make sure, that:  
 
When converting an old static page into a [[WikiDocs]] page, make sure, that:  
* The [[WikiDocs]] page has a ''really [[Good WikiName|GoodWikiName]]''. [[WikiDocs]] pages ''cannot'' be renamed, so you'll have to get it right from the start.  
+
* The [[WikiDocs]] page has a ''really [[Good WikiName|GoodWikiName]]''. [[WikiDocs]] pages are somewhat harder to rename, so you'll have to get it right from the start.  
 
* Preserve all links: Make sure the new [[WikiDocs]] page contains all links that the old static page had. This is important because otherwise you could cut off a part of the documentation.  
 
* Preserve all links: Make sure the new [[WikiDocs]] page contains all links that the old static page had. This is important because otherwise you could cut off a part of the documentation.  
 
* [[Wiki Docs Pages|WikiDocsPages]] ''must never be renamed''. Therefore they should all have the following ACL line:   
 
* [[Wiki Docs Pages|WikiDocsPages]] ''must never be renamed''. Therefore they should all have the following ACL line:   
Line 22: Line 20:
 
</ul>A member of the [[Admin Group|AdminGroup]] will have to add this for you.  
 
</ul>A member of the [[Admin Group|AdminGroup]] will have to add this for you.  
  
==Pages to Become WikiDocs Pages==
+
==Pages which will be made into WikiDocs Pages==
  
'''Status:''' ''I am currently reworking the list into a table that shows which content is where.''
+
See also [[MusicBrainz Documentation|MusicBrainzDocumentation]] and even more importantly [[Restructuring The Documentation|RestructuringTheDocumentation]] for some prior work on this (especially proposed [[Wiki Name|WikiName]]<code><nowiki></nowiki></code>s). This table follows the structure of the new top menu bar:  
 
 
Initially I started a semi-structured list with the idea of creating a new [[Main Site Structure|MainSiteStructure]]. But now we first need an overview about the status quo, and the structure created by [[User:Keschte|Keschte]] is pretty good to start with. See also [[MusicBrainz Documentation|MusicBrainzDocumentation]] and even more importantly [[Restructuring The Documentation|RestructuringTheDocumentation]] for some prior work on this (especially proposed [[Wiki Name|WikiName]]<code><nowiki></nowiki></code>s). This table follows the structure of the new top menu bar:  
 
 
{| border="1"
 
{| border="1"
 
|-
 
|-
Line 83: Line 79:
  
 
... More to add  
 
... More to add  
* [[Frequently Asked Questions|FrequentlyAskedQuestions]] or [http://www.musicbrainz.org/wd/FAQIndex http://www.musicbrainz.org/wd/FAQIndex]  
+
* [[Frequently Asked Questions|FrequentlyAskedQuestions]] or [http://www.musicbrainz.org/wd/FAQIndex http://www.musicbrainz.org/wd/FAQIndex]  [[Image:Checkmark.png]] done, by [[User:WolfSong|WolfSong]]  
** All pages of* [[MusicBrainz Forum|MusicBrainzForum]]<code><nowiki></nowiki></code>s or [http://www.musicbrainz.org/wd/ContactUs http://www.musicbrainz.org/wd/ContactUs] i.e. Where can I reach you, where can I get help  
+
** All pages of[[Image:Checkmark.png]] done, by [[User:WolfSong|WolfSong]]
 +
 
 +
* [[MusicBrainz Forum|MusicBrainzForum]]<code><nowiki></nowiki></code>s or [http://www.musicbrainz.org/wd/ContactUs http://www.musicbrainz.org/wd/ContactUs] i.e. Where can I reach you, where can I get help  
 
** [[MusicBrainz Wiki|MusicBrainzWiki]] i.e a page that ''describes'' the function of the wiki.  
 
** [[MusicBrainz Wiki|MusicBrainzWiki]] i.e a page that ''describes'' the function of the wiki.  
 
** [[Edit Note|EditNote]]  
 
** [[Edit Note|EditNote]]  

Revision as of 12:48, 20 June 2006

WikiDocs Pages

Attention.png This page lists all wiki pages that should be part of the initial WikiDocs launch and listed in the WikiTransclusion table.

General Issues

To decide which pages nedd to be added to the transclusion table I ask myself two questions:

  • What pages are relevant to a newcomer to MusicBrainz? These are the pages that should be moderated. Pages that are only relevant to people who are already accustomed to MusicBrainz can stay in the MusicBrainzWiki and do not need to be moderated, since a member of the MusicBrainz community can (or should learn to) retrieve informaiton from the wiki.
  • What pages reflect an official position of the MusicBrainz project? The responsible persons need to have some control over these pages, thus they need to be moderated.

Generally I try to have as few pages in the WikiTransclusion table as possible. I think we should start out low. We can always add more pages later if we get problems with spammers and vandals. MoinMoin has an AntiSpamGlobalSolution against the latter.

Migration Guideline

When converting an old static page into a WikiDocs page, make sure, that:

  • The WikiDocs page has a really GoodWikiName. WikiDocs pages are somewhat harder to rename, so you'll have to get it right from the start.
  • Preserve all links: Make sure the new WikiDocs page contains all links that the old static page had. This is important because otherwise you could cut off a part of the documentation.
  • WikiDocsPages must never be renamed. Therefore they should all have the following ACL line:
  • ## DontRenameWikiDocsPages! #acl -All:delete Default

A member of the AdminGroup will have to add this for you.

Pages which will be made into WikiDocs Pages

See also MusicBrainzDocumentation and even more importantly RestructuringTheDocumentation for some prior work on this (especially proposed WikiNames). This table follows the structure of the new top menu bar:

Position in SiteMenu Current URL Corresponding WikiPage Notes TODO Priority
About
About MusicBrainz http://musicbrainz.org/doc/AboutMusicBrainz AboutMusicBrainz That is the page which hosts the content in question. I have no problems with the WikiName, but Alex once said it was not that good. review WikiPage {*} {*} {*}
Privacy http://musicbrainz.org/privacy which redirects to http://musicbrainz.org/docs/20050213-1.html ModeratorPrivacy The WikiPage contains some discussion but not the content of the current static page. There is no /wd/ page. Dupuy Proposed to leave this as a static page, this is a contract with our users after all. decide {o} {o} {o}
History http://musicbrainz.org/wd/MusicBrainzHistory MusicBrainzHistory done. {*} {*} {o}
People http://musicbrainz.org/wd/MusicBrainzBio MusicBrainzBio We need to decide whether to use one single page or inclusions to OfficialBio SubPages in the wiki. Solved using brief summaries, with links to /OfficialBio subpages. done. {*} {*} {o}
Licenses http://musicbrainz.org/about/licenses.html MusicBrainzLicense create page, intertwingle done. {o} {o} {o}
Social Contract http://musicbrainz.org/contract.html SocialContract create page, intertwingle done. {o} {o} {o}
Software http://musicbrainz.org/wd/MusicBrainzEnabledApplications MusicBrainzEnabledApplications OtherPrograms would be analog to OtherDatabases, but is not ideal. MusicBrainzClient is better, but currently redirects to ClientLibrary create new WikiPage, copy content, intertwingle {*} {*} {o}
Logos http://musicbrainz.org/about/logos.html none not really important, IMO {o} {o} {o}
Statistics http://musicbrainz.org/about/stats.html MusicBrainzStatistics ? A wikipage that lists all available stats would be good create WikiPage and intertwingle {*} {o} {o}
Mirrors http://musicbrainz.org/about/mirrors.html MirrorServer - done. {*} {o} {o}
Elections http://musicbrainz.org/user/election/ none Automatically generated page cannot be wikified leave it {o} {o} {o}
News
General News http://musicbrainz.org/news/index.html none Unwikifiable page {o} {o} {o}
Blog redirects to blog.musicbrainz.org {o} {o} {o}
Server, libmusicbrainz, libtunepimp, MusicBrainz Tagger, Picard http://musicbrainz.org/news/server.html none Unwikifiable pages {o} {o} {o}
In the Press http://musicbrainz.org/wd/MusicBrainzPress MusicBrainzPress Should be updated by the community used existing page. done. {*} {o} {o}
Download
Download http://musicbrainz.org/download.html Products done. {*} {*} {o}
MusicBrainz Tagger http://musicbrainz.org/tagger/index.html MusicBrainzTagger - done. {*} {*} {*}
... more to add (the following is not complete nor ordered anymore)
Contribute
How to Contribute http://musicbrainz.org/wd/Contribute HowToContribute Pages are roughly equal review page {*} {*} {o}
Development http://musicbrainz.org/development/index.html MusicBrainzDevelopment These two pages are very different. I think the wiki page is not up to date anymore (We're using Trac now). rewrite wiki page and wikify static pages {*} {*} {*}
Avout Editing http://www.musicbrainz.org/mod_intro.html HowEditingWorks Clone of the old page, needs to be massively enhanced enhance {*} {*} {*}

... More to add

  • It is my understanding that very few of the actual documentation needs to be moderated. Ideally those pages that give a structured introduction to all pages which document a certain feature should be moderated, but these actual pages should not. It is enough that the introductory page declares that the rest is maintaned by the wiki community. Only if we experience vandalism, should we add all these pages to the ModeratedRevisionTable --DonRedman * AdvancedRelationships (once this has stabilzed and only if we have troubles with vandals all the subpages) * EditType (but IMO not the edit type pages themeselves) * ... * MusicBrainzTerminology ** probably all pages of Category Terminology