History:Documentation Release/1.0: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
(notes (Imported from MoinMoin))
 
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Documentation Release: 1.0=
=Documentation Release: 1.0=

Preliminary draft. Be sure to read [[Documentation Release|DocumentationRelease]] and possibly [[User:dmppanda/DocumentationRelease|that other blob]]


==Covered==
==Covered==


All depth-1 links from the navs for topics:
All terminology in:
*****?
⚫
****==Content objectives==
* ARs?
* howtos?

⚫
==Content objectives==


* spelling
* spelling
* up to date
* up to date
* no outstanding issues
* cards (header/footer)
* topic cards
* transclusion
* documentation cards
⚫
* examples for all docs
* transclusion for part of the content (prob at least all)


==Not in this release, but later==
==Only partly in this release==


⚫
* examples for all docs
* all ARs and [[Edit Types|EditTypes]] for the given categories
* all ARs for the given categories
* no [[Camel Case|CamelCase]] links for transcluded material in these categories
* no [[Camel Case|CamelCase]] links for transcluded material in these categories
* screenshots
* screenshots for "how that works" pages?

==Probably for the next release==

* completely rehaul (and finish up) [[Edit Type|EditType]]<code><nowiki></nowiki></code>s documentation pages, and intertwingle them good from all relevant points (eg: Terminology like [[Artist Type|ArtistType]] etc)

==Status==

Gone through the easy parts (Label, Annotation).
* still need to come back on label ARs to move the crumbing to ARs instead (also possibly check the howto, and assess if an howto crumbing makes any sense).
* need to go through all ARs in depth for Labels to add AR crumbing and check again the categorization
* need to add the documentation header to all labels pages (and snip out the wiki nav stuff from the [[Label Header|LabelHeader]])

Artists:
* starts to look better. Need to have the issues solved by the style-gang about Perf/Alias and birth dates/perf-legal
* need to transclude a good part of it (should be ACLed-ready)

Reminder:
* check if transclusion of cards is done once or many times

Plans about doc crumbing:
* [[User:dmppanda/tests|dmppanda/tests]] (needs approval from headquarters for the use of a third party GPL icon set)

Tracks:
* yet untouched


[[Category:To Be Reviewed]] [[Category:Artist]] [[Category:Release]] [[Category:Label]] [[Category:Annotation]]
[[Category:To Be Reviewed]] [[Category:Artist]] [[Category:Release]] [[Category:Label]] [[Category:Annotation]] [[Category:Track]] [[Category:Terminology]]

Latest revision as of 16:07, 3 July 2013

Documentation Release: 1.0

Preliminary draft. Be sure to read DocumentationRelease and possibly that other blob

Covered

All depth-1 links from the navs for topics:

          • ?
  • ARs?
  • howtos?

Content objectives

  • spelling
  • up to date
  • no outstanding issues
  • topic cards
  • documentation cards
  • transclusion for part of the content (prob at least all)

Only partly in this release

  • examples for all docs
  • all ARs for the given categories
  • no CamelCase links for transcluded material in these categories
  • screenshots for "how that works" pages?

Probably for the next release

  • completely rehaul (and finish up) EditTypes documentation pages, and intertwingle them good from all relevant points (eg: Terminology like ArtistType etc)

Status

Gone through the easy parts (Label, Annotation).

  • still need to come back on label ARs to move the crumbing to ARs instead (also possibly check the howto, and assess if an howto crumbing makes any sense).
  • need to go through all ARs in depth for Labels to add AR crumbing and check again the categorization
  • need to add the documentation header to all labels pages (and snip out the wiki nav stuff from the LabelHeader)

Artists:

  • starts to look better. Need to have the issues solved by the style-gang about Perf/Alias and birth dates/perf-legal
  • need to transclude a good part of it (should be ACLed-ready)

Reminder:

  • check if transclusion of cards is done once or many times

Plans about doc crumbing:

  • dmppanda/tests (needs approval from headquarters for the use of a third party GPL icon set)

Tracks:

  • yet untouched
Retrieved from "https://wiki.musicbrainz.org/index.php?title=History:Documentation_Release/1.0&oldid=63894"