mahara-contributors team mailing list archive

[François Marier <francois@xxxxxxxxxx>]

In terms of how long we keep documentation around, I think we can say
that we only have documentation for supported versions. So that would
currently be 1.2 and 1.3. Once 1.4 is released, we'll be dropping
support for 1.2. So we can probably focus on 1.3/1.4 and ignore 1.2.

I'm not against labelling sections / paragraphs (or even pages in the
case of a page what would talk about a 1.3 only feature for example) to
let people know what version it refers to. However I'd like to avoid
having two parallel versions of the documentation because it's likely to
end into two versions that are out of sync and have duplicated info.

-- 
You received this bug notification because you are a member of Mahara
Contributors, which is subscribed to Mahara.
https://bugs.launchpad.net/bugs/723210

Title:
  mahara.org wiki documentation needs to be updated for 1.3 and 1.4

Status in Mahara ePortfolio:
  Confirmed

Bug description:
  Mahara wiki content needs an overhaul to bring it into line with 1.3
  and 1.4 versions.

  A lot of the existing 'User Guide' content doesn't seem to have been
  updated since ~2008 and it'd be good to separate the information out
  on the wiki into the two versions, much like how Moodle has gone about
  1.9 vs 2.0 documentation.

  Roadmap could also do with some structure and collation so information
  can be easily seen when new 1.5 roadmap specification items are added
  under a separate section.  It might be a good idea to try and avoid
  having wishlist items there anyway and keep those discussions on
  forums and here in launchpad before moving to the wiki as official
  design specifications/roadmap when ready.

  Ideas:
  - Roadmap -> 1.3/1.4 -> items/details -> specification (if available; removing "wishlist")
  - User Guides -> 1.3/1.4 -> Dashboard/Content/Porfolio etc
  - Site Administration Guides -> 1.3/1.4 -> General/Groups/Users/Institutions etc
  - Institution Administration Guides -> 1.3/1.4 -> 

  Themes - has the design of this changed much between versions?
  System Adminstration Guide -  is it worth separating this out for ease of finding information? does it vary much?
  Language Packs -  already has version availability table
  Plugins - shall we create versions here too and plugin maintainers can add information when/if a plugin is upgraded for new versions? Or copy somewhat the way that Language packs are currently maintaining supported versions?

  Some of the content might not change that much between versions but it
  might be worth separating that out now while we can to future proof
  for bigger version differences in those areas.

  I have only been looking at the English documenation. :)