Provide new tutorial materials (Trac #928)

[smk78]

We need to replace the dated and monolithic (!SasView 2.x) Tutorial that presently ships with !SasView 4.x with new materials that are fresh, engaging, and modern.

This is an umbrella ticket for this 'next generation' material, the development of which will be discussed and directed at

http://trac.sasview.org/wiki/TutorialsTNG

Several existing tickets relating to the provision of 'tutorials' are now captured on this wiki page and the corresponding tickets closed:

Closes SasView/sasview#521 - Need new tutorial documentation
Closes SasView/sasview#649 - Add Pr Tutorial module
Closes SasView/sasview#650 - Add Invariant Tutorial Module
Closes SasView/sasview#651 - Add 1D model fitting tutorial
Closes SasView/sasview#652 - Add 2D model fitting Tutorial
Closes SasView/sasview#653 - Add constrained fit Tutorial
Closes SasView/sasview#654 - Add simultaneous fitting tutorial
Closes SasView/sasview#655 - Add Batch Fitting Tutorial

Some of the 'next generation' material will require our !SasView documentation build processes to produce PDF files. Tickets relevant to this are:

Refs SasView/sasview#643 - Build PDF documentation along with HTML
Refs SasView/sasview#1009 - Add !PanDoc to Build Servers

Migrated from http://trac.sasview.org/ticket/928

{
    "status": "new",
    "changetime": "2019-03-28T09:28:35",
    "_ts": "2019-03-28 09:28:35.857924+00:00",
    "description": "We need to replace the dated and monolithic (!SasView 2.x) Tutorial that presently ships with !SasView 4.x with new materials that are fresh, engaging, and modern.\n\nThis is an umbrella ticket for this 'next generation' material, the development of which will be discussed and directed at\n\nhttp://trac.sasview.org/wiki/TutorialsTNG\n\nSeveral existing tickets relating to the provision of 'tutorials' are now captured on this wiki page and the corresponding tickets closed:\n\nCloses SasView/sasmeta#13 - Need new tutorial documentation\nCloses SasView/sasview#516 - Add Pr Tutorial module\nCloses SasView/sasview#517 - Add Invariant Tutorial Module\nCloses SasView/sasview#518 - Add 1D model fitting tutorial\nCloses SasView/sasview#519 - Add 2D model fitting Tutorial\nCloses SasView/sasview#520 - Add constrained fit Tutorial\nCloses SasView/sasview#521 - Add simultaneous fitting tutorial\nCloses SasView/sasview#522 - Add Batch Fitting Tutorial\n\nSome of the 'next generation' material will require our !SasView documentation build processes to produce PDF files. Tickets relevant to this are:\n\nRefs SasView/sasview#510 - Build PDF documentation along with HTML\nRefs SasView/sasview#927 - Add !PanDoc to Build Servers\n\n",
    "reporter": "smk78",
    "cc": "",
    "resolution": "",
    "workpackage": "SasView Documentation",
    "time": "2017-04-06T15:09:56",
    "component": "SasView",
    "summary": "Provide new tutorial materials",
    "priority": "critical",
    "keywords": "",
    "milestone": "SasView 4.3.0",
    "owner": "",
    "type": "task"
}

[butlerpd]

Trac update at 2017/12/10 01:31:50:

• butler commented:

Tutorials now just need to be written... one piece at a time. They will not get written for 4.2 (though some more pieces may?) so moving this ticket to 4.3 now.

• butler changed milestone from "SasView 4.2.0" to "SasView 4.3.0"

[smk78]

Trac update at 2019/03/28 09:28:35: smk78 changed type from "defect" to "task"

[butlerpd]

@smk78. Several questions here: First it seems that this issue, which looks to be copied from the wiki we created at the Delft code camp, can now be closed as all the associated tickets are closed? Secondly Tutorials are a separate repo and independent of SasView or sasmodels releases (other than the latest tutorials being scraped into the SasView release) so future tickets of this nature should I think be added to that repo's issues. Rather than move this to that repo right now I will move it to the admin milestone to await some final decisions.

[smk78]

The only reason those tickets appear as closed is because I closed them specifically to create this umbrella ticket and make ticket management easier! Only 3 or 4 of the tutorials listed above have actually been created.

[smk78]

PS: I don't have a problem with reassigning this to the tutorials repo, except to point out that documentation issues are already split between sasview and sasmodels and so we would just be adding another layer of complexity. Non-tutorial documentation tickets wouldn't move to the tutorial repo.

[butlerpd]

I preparation for contributor camp XII, am wondering if this issue should be retired? Maybe a question most relevant for @smk78? It is quite old and most of the things here (if not all) have been done. I would recommend however we open new issues for tutorials that we would like to see and that could be good candidates for anyone wanting to work on a tutorial?

[smk78]

Yes, I concur that we can now gracefully retire this issue. A more evergreen list is on the wiki:
https://github.com/SasView/sasview/wiki/TutorialsTNGList