Difference between revisions of "WikiDocs"

From MusicBrainz Wiki
(updated progress a bit (Imported from MoinMoin))
(starting to clean this up (Imported from MoinMoin))
Line 1: Line 1:
 
=Basing the Documentation on the Wiki=
 
=Basing the Documentation on the Wiki=
  
[[Image:Alert.png]] '''Warning''' the pages on WikiDocs are currently in transition.  
+
[[Image:Alert.png]] '''''Warning''' the pages on WikiDocs are currently in transition.''
  
 
This is [[Current Work|CurrentWork]].  
 
This is [[Current Work|CurrentWork]].  
Line 16: Line 16:
  
 
* All content will reside in the [[MusicBrainz Wiki|MusicBrainzWiki]]. The [[Wiki Migration|WikiMigration]] to [[Moin Moin|MoinMoin]] was an essential precondition.  
 
* All content will reside in the [[MusicBrainz Wiki|MusicBrainzWiki]]. The [[Wiki Migration|WikiMigration]] to [[Moin Moin|MoinMoin]] was an essential precondition.  
* [[Wiki Docs Moderators|WikiDocsModerators]] select important wiki pages and register their last stable revision as [[Moderated Revision|ModeratedRevision]] in the [[Moderated Revision Table|ModeratedRevisionTable]].  
+
* [[Wiki Docs Moderators|WikiDocsModerators]] select important wiki pages that should become [[WikiDocs Page|WikiDocsPage]]<code><nowiki></nowiki></code>s. They enter the last stable revision of that page into the [[Moderated Revision Table|ModeratedRevisionTable]].  
 
* Users visiting the [[MusicBrainz Wiki|MusicBrainzWiki]] will see no difference.  
 
* Users visiting the [[MusicBrainz Wiki|MusicBrainzWiki]] will see no difference.  
* Users visiting the [[Main Site|MainSite]] will be served content from the [[Moderated Revision|ModeratedRevision]] of moderated wiki pages via the [[Wiki Web Service|WikiWebService]]. If there is no [[Moderated Revision|ModeratedRevision]], the webservice serves the content of the normal wiki page, but with a warning that this is unmoderated content. The pages served by the webservice will not be editable.  
+
* Users visiting the [[Main Site|MainSite]] will be served content from the [[Moderated Revision|ModeratedRevision]] of moderated wiki pages via the [[Wiki Web Service|WikiWebService]], which will do some [[WikiDocs Conversion|WikiDocsConversion]]. If there is no [[Moderated Revision|ModeratedRevision]], the webservice serves the content of the normal wiki page, but with a warning that this is unmoderated content. The pages served by the webservice will not be editable.  
  
 
====Initial idea====
 
====Initial idea====

Revision as of 23:57, 25 October 2005

Basing the Documentation on the Wiki

Alert.png Warning the pages on WikiDocs are currently in transition.

This is CurrentWork.

We want to base more of the main site's content on the very good documentation that has evolved in this wiki.

WikiDocsConcept

The main idea of the WikiDocs is that there will be no separate documentation. All docs will be in the 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 WikiDocsConcept for more details.

The components of the WikiDocs

Current Model

Initial idea

File:WikiDocsConcept.png

Related Implementations

Related projects and ideas on other wikis:

  • WikiTransclusion used by the High Availability Linux project for their documentation.

Progress of this Project

The WikiDocsPlan will describe the steps towards a complete WikiDocs system (I just don't have the time to write it up yet --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.

DonRedman has written DonsWikiDocsConcept to describe his concerns and offer a solution. This is of historical interest only. There is also a full discussion (mostly between Dupuy and DonRedman).

Then RobertKaye and DonRedman have met in Hamburg, drank some beer and thought of this WikiDocsConcept.

JohnCarter has taken up the job of the actual WikiMigration, in which this wiki has been moved from UseMod (former) to MoinMoin (current).


Can all WikiDocs moderators be listed, maybe on this page? --Zout