Difference between revisions of "WikiDocs"

From MusicBrainz Wiki
((Imported from MoinMoin))
 
m (simplify language)
 
(46 intermediate revisions by 18 users not shown)
Line 1: Line 1:
=Basing the Documentation on the Wiki=
+
Most of MusicBrainz's documentation is located at https://wiki.musicbrainz.org/ and transcluded at https://musicbrainz.org/doc/.
  
This is [[Current Work|CurrentWork]]  
+
This WikiDocs system works because:
 +
# It leaves the wiki (and by extension, the documentation) open for mass collaboration.
 +
# It lets [[Transclusion Editor|transclusion editors]] control what can be seen on the main site.
  
We want to base more of the main site's content on the very good documentation that has evolved in this wiki.  
+
== WikiDocs Structure ==
 +
[[Image:WikiDocs_System_v1.png|right|350px|WikiDocs components]]
  
==WikiDocsConcept==
+
The structure of the WikiDocs system looks like this:
 +
# The content resides in the wiki, and anyone can edit and maintain it.
 +
# [[Transclusion Editor|Transclusion editor]]s add and update entries in the [[mb:admin/wikidoc|transclusion table]] for official documentation pages.
 +
# Users visiting a page on the wiki see no difference; they always see the most recent revision of every page.
 +
# Users visiting that same page on the main website will be shown, via transclusion, only the latest reviewed revision of that page.
  
The main idea of the WikiDocs is that there will be ''no separate documentation''. ''All'' docs will be in the [[MusicBrainz Wiki|MusicBrainzWiki]]. Think of it like an open source project with a development and a stable release: The wiki markup text and the versions stored in the wiki are like the source code in CVS. The wiki as rendered by the wiki engine is like the development release, it contains the bleeding edge ideas, docs, discussions etc. This is good but confusing for new users. Thus we make something like a stable release of the wiki which consists of a structured portal to a moderated mirror of the wiki. See [[WikiDocs Concept|WikiDocsConcept]] for more details.  
+
Pages served via transclusion cannot be edited on the website.
  
===The components of the WikiDocs===
+
==How To Transclude a WikiDocs Page==
  
* the [[MusicBrainz Wiki|MusicBrainzWiki]] (which will be [[Wiki Migration|ported]] to [[Moin Moin|MoinMoin]]),
+
'''Only transclusion editors can do this.'''
* a [[Moderated Wiki Mirror|ModeratedWikiMirror]] (probably realized through a [[Shadow Wiki|ShadowWiki]]),
 
* a [[Wiki Doc Converter|WikiDocConverter]] by which [[Wiki Doc Moderator|WikiDocModerator]]s can copy a specific version of a wiki page to the [[Moderated Wiki Mirror|ModeratedWikiMirror]],
 
* a [[Wiki Web Service|WikiWebService]] that serves the content of the [[Moderated Wiki Mirror|ModeratedWikiMirror]] or the real [[MusicBrainz Wiki|MusicBrainzWiki]] where appropriate
 
* a new and reduced [[Main Site Structure|MainSiteStructure]] that serves as a portal to the [[Moderated Wiki Mirror|ModeratedWikiMirror]].  
 
  
[[Image:WikiDocsConcept.png]]  
+
: [[Image:Attention.png]] ''Please be very careful to enter the correct page name and revision number, because they are '''not''' checked for correctness.''
  
==Related Implementations==
+
Go to the [[mb:admin/wikidoc|wiki transclusion table]]. Each page has its own row, which can be edited or removed. New rows can also be added. When a [[WikiDocs]] page has been edited, and the change conforms with the style guidelines and other social aspects — and most importantly, makes the documentation better — the change should be reflected on the main server. To do this, find the latest revision number using the page history and update it in the transclusion table.
  
Related projects and ideas on other wikis:
+
When adding a new page to the table, make sure to add it to the [[:Category:WikiDocs Page|WikiDocs page]] category.
* The general idea we are trying to realize is described as [http://wikifeatures.wiki.taoriver.net/moin.cgi/StagedCommits StagedCommits] on the [http://wikifeatures.wiki.taoriver.net/ WikiFeaturesWiki].
 
* [[Rhizome Wiki|RhizomeWiki]] is written in python and has a label attribute that can be set to "draft" or "released". The Wiki engine will display the latest released version. Search for "Label" on [http://rhizome.liminalzone.org/RhizomeManual#id1099155628 this page].
 
* There is some discussion on [http://www.usemod.com/cgi-bin/mb.pl?MeatballWiki MeatBall] on this: [http://www.usemod.com/cgi-bin/mb.pl?LayeredWikiInterface LayeredWikiInterface] and [http://www.usemod.com/cgi-bin/mb.pl?StableCopy StableCopy].
 
* There is a [http://www.srcf.ucam.org/~cjp39/Peri/StableCopy StableCopy] (also called [http://www.srcf.ucam.org/~cjp39/Peri/StableView StableView]) mechanism implemented on [http://www.srcf.ucam.org/~cjp39/Peri/PeriPeri PeriPeri]. This is not identical to the WikiDocs concept but it might be an alternative. Periperi is written in perl; see the [http://www.srcf.ucam.org/~cjp39/Peri/Source/peri.cgi source]. Captain solo tried to install Periperi and encountered some [http://captsolo.net/info/blog_a.php/2004/05/04/p497 problems]. Perhaps his experience helps. 
 
** [http://wikifeatures.wiki.taoriver.net/ WikiFeaturesWiki] calls this [http://wikifeatures.wiki.taoriver.net/moin.cgi/DelayedCommits DelayedCommits].  
 
  
* [http://wwnew.linux-ha.org/WikiTransclusion WikiTransclusion] used by the High Availability Linux project for their documentation.
+
[[Category:Wiki]] [[Category:WikiDocs Page]]
 
 
==Progress of this Project==
 
 
 
''The [[Wiki Docs Plan|WikiDocsPlan]] will describe the steps towards a complete WikiDocs system (I just don't have the time to write it up yet --[[User:DonRedman|DonRedman]])''
 
 
 
There has been a first attempt to do this in a separate wiki, but this has been stopped because of some concerns for this wiki.
 
 
 
[[User:DonRedman|DonRedman]] has written [[Don's WikiDocs Concept|DonsWikiDocsConcept]] to describe his concerns and offer a solution. This is of historical interest only. There is also a [http://lists.musicbrainz.org/pipermail/musicbrainz-advisors/2005-April/000049.html full discussion] (mostly between [[User:Dupuy|Dupuy]] and [[User:DonRedman|DonRedman]]).
 
 
 
Then [[User:RobertKaye|RobertKaye]] and [[User:DonRedman|DonRedman]] have met in Hamburg, drank some beer and thought of this [[WikiDocs Concept|WikiDocsConcept]]. 
 
 
 
[[User:ZeroGravitas|ZeroGravitas]] has taken up the job of the actual [[Wiki Migration|WikiMigration]], in which this wiki will be moved from [[Use Mod|UseMod]] (current) to [[Moin Moin|MoinMoin]]. 
 
 
 
--------
 
 
 
[[Image:Alert.png]] The Markup on This Page Needs Fixing
 
 
 
This wiki page has been ported by the [[Wiki Migration Bot|WikiMigrationBot]], and this link to the [[Wiki Migration Bot Report|WikiMigrationBotReport]] flags that this page contains wiki markup that needs fixing.
 
 
 
[[Wiki Name In Title|WikiNameInTitle]]<code><nowiki></nowiki></code>s on these lines:
 
* 11 <code><nowiki> === The components of the WikiDocs === </nowiki></code>
 
* 6 <code><nowiki> == WikiDocsConcept == </nowiki></code>
 
 
 
[[Category:To Be Reviewed]] [[Category:Documentation]]
 

Latest revision as of 13:36, 23 January 2021

Most of MusicBrainz's documentation is located at https://wiki.musicbrainz.org/ and transcluded at https://musicbrainz.org/doc/.

This WikiDocs system works because:

  1. It leaves the wiki (and by extension, the documentation) open for mass collaboration.
  2. It lets transclusion editors control what can be seen on the main site.

WikiDocs Structure

WikiDocs components

The structure of the WikiDocs system looks like this:

  1. The content resides in the wiki, and anyone can edit and maintain it.
  2. Transclusion editors add and update entries in the transclusion table for official documentation pages.
  3. Users visiting a page on the wiki see no difference; they always see the most recent revision of every page.
  4. Users visiting that same page on the main website will be shown, via transclusion, only the latest reviewed revision of that page.

Pages served via transclusion cannot be edited on the website.

How To Transclude a WikiDocs Page

Only transclusion editors can do this.

Attention.png Please be very careful to enter the correct page name and revision number, because they are not checked for correctness.

Go to the wiki transclusion table. Each page has its own row, which can be edited or removed. New rows can also be added. When a WikiDocs page has been edited, and the change conforms with the style guidelines and other social aspects — and most importantly, makes the documentation better — the change should be reflected on the main server. To do this, find the latest revision number using the page history and update it in the transclusion table.

When adding a new page to the table, make sure to add it to the WikiDocs page category.