Opened 3 years ago

Closed 8 months ago

#387 closed defect (fixed)

Need new tutorial documentation

Reported by: butler Owned by: smk78
Priority: major Milestone: SasView Next Release +1
Component: SasView Keywords:
Cc: Work Package: SasView Documentation

Description

The old tutorial file is quite dated now and needs a complete rewrite.

Change History (9)

comment:1 Changed 22 months ago by butler

  • Milestone changed from SasView Next Release +1 to SasView 4.0.0
  • Priority changed from major to critical

Starting this task is a core task for code camp IV/release 4.0 … but not necessarily finishing it. Thus not sure whether to mark as blocker or critical? For now going to mark it critical.

comment:2 Changed 22 months ago by butler

  • Owner set to smk78
  • Priority changed from critical to blocker
  • Status changed from new to assigned

Moving to blocker to make clear distinction between core tasks (blocker) and related tasks (critical) and important wish lists (major).

comment:3 Changed 21 months ago by butler

Upon review, the current tutorial is not as much a tutorial as a more graphical and slightly more detailed user documentation. This should be replaced with proper tutorial documentation which actually takes a user thought the steps to getting actual answers at the end, starting from example data sets loaded with SasView. These should be modular so that tutorials can be added as we go along but also be bundled into a single PDF or HTML for someone who wants to get the whole lot without having to make sure they've downloaded all the individual tutorial modules. This will be an ongoing task so this ticket should be considered complete when a starting list of tutorials needed has been generated and tickets created and at least one tutorial has been completed and builds properly for distribution.

comment:4 Changed 21 months ago by butler

  • Priority changed from blocker to major

Only getting started on this project was part of code camp VI. Having established a plan and the critical items for a release beginning to be urgent, this is now done. Will downgrade to major with the idea that it will move to next release milestone when we are ready for a release.

comment:5 Changed 18 months ago by butler

  • Milestone changed from SasView 4.0.0 to SasView Next Release +1

It is clear no more will be done for this release on this ticket so moving to next+1 as suggested earlier.

comment:6 Changed 16 months ago by butler

  • Milestone changed from SasView Next Release +1 to SasView 4.1.0

comment:7 Changed 14 months ago by smk78

This ticket is stalled whilst we assess the best technology platform(s) for actually providing the tutorials. Whilst ReST (for Sphinx harmonisation) carries many advantages, from the perspective of those we intend to get to write the tutorials (various SANS instrument team staff) the learning curve is steep and the production overhead (ie, the time spent trying to get content to satisfy ResT/Sphinx/LaTex/MathJax coding rules) is high. Is there anything out there, for example, like Word that generates ReST???

comment:8 Changed 14 months ago by smk78

  • Milestone changed from SasView 4.1.0 to SasView Next Release +1

comment:9 Changed 8 months ago by smk78

  • Resolution set to fixed
  • Status changed from assigned to closed

Superseded by #928
Ticket closed.

Note: See TracTickets for help on using tickets.