Roundup Tracker - Issues

Issue 2551002

classification
Add errata pages on wiki and reference them from delivered documents
Type: behavior Severity: normal
Components: Documentation Versions: devel, 2.0.0alpha
process
Status: fixed fixed
:
: rouilj : rouilj
Priority: normal : Effort-Low

Created on 2018-09-08 01:40 by rouilj, last changed 2019-10-13 22:09 by rouilj.

Messages
msg6242 Author: [hidden] (rouilj) Date: 2018-09-08 01:40
I just released a new version of the roundup docs from the maint-1.6
branch. This fixes an example that was broken.

However this means that the released docs are not in sync with the web
site docs.

It would be nice to link the released docs to an DocErrata1_6_0 page on
the wiki so that this could have been handled by updating the errata
page. However to do that the docs should include a link to the
site of the (future) errata page.

I think we just need one DocErrata page per release that can be
created if needed.

I would say include a link to the errata page in:

  installation.txt
  upgrading.txt
  customizing.txt
  admin_guide.txt
  user_guide.txt

I don't think the other pages change enough or are used enough
to need to publish errata.
msg6740 Author: [hidden] (rouilj) Date: 2019-10-13 22:09
Created https://wiki.roundup-tracker.org/ReleaseErrata. Referenced from index.html in docs.

Each header will be for a single revision. So one page for all releases.
This makes managing pages and changes to doc less burdensome.
History
Date User Action Args
2019-10-13 22:09:46rouiljsetstatus: new -> fixed
assignee: rouilj
resolution: fixed
messages: + msg6740
versions: + 2.0.0alpha
2018-09-08 01:40:21rouiljcreate