Restructure top level of documentation window in application (Trac #436)

[butlerpd]

As noted by Richard Heenand during the !SasView 3.1 release testing phase as well as others, the top level tree gives user and developer documentation requiring the user to click twice to get to appropriate documentation. Further model documentation which is really user documentation and is approriately placed under user documentation, is inexpicably duplicated at the top level on a par with developer and user documentation.

To Do:

• Need to remove the top level call to model documentation.
• Should make top level documentation the user documentation so users don't have to click twice
• Decide what to do about developer docs. Richard suggests putting them under user docs but this seems a bit obfuscational as it is NOT a user documentation. It is still available from the command line and can be raised with a browser by appropriate call to top level index. Further suggest we start pushing the docs build to the website so is available with loading !SasView. Here the index would be the top level and have both user and developer docs as links.

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

{
    "status": "closed",
    "changetime": "2016-03-06T19:10:29",
    "_ts": "2016-03-06 19:10:29.569706+00:00",
    "description": "As noted by Richard Heenand during the !SasView 3.1 release testing phase as well as others, the top level tree gives user and developer documentation requiring the user to click twice to get to appropriate documentation.  Further model documentation which is really user documentation and is approriately placed under user documentation, is inexpicably duplicated at the top level on a par with developer and user documentation.\n\nTo Do:\n* Need to remove the top level call to model documentation.  \n* Should make top level documentation the user documentation so users don't have to click twice\n* Decide what to do about developer docs.  Richard suggests putting them under user docs but this seems a bit obfuscational as it is NOT a user documentation.  It is still available from the command line and can be raised with a browser by appropriate call to top level index.  Further suggest we start pushing the docs build to the website so is available with loading !SasView.  Here the index would be the top level and have both user and developer docs as links.",
    "reporter": "butler",
    "cc": "",
    "resolution": "fixed",
    "workpackage": "SasView Documentation",
    "time": "2015-06-29T03:39:49",
    "component": "SasView",
    "summary": "Restructure top level of documentation window in application",
    "priority": "minor",
    "keywords": "",
    "milestone": "SasView 4.0.0",
    "owner": "butler",
    "type": "enhancement"
}

[butlerpd]

Trac update at 2015/06/29 03:40:20: butler changed description from:

As noted by Richard Heenand during the SasView 3.1 release testing phase as well as others, the top level tree gives user and developer documentation requiring the user to click twice to get to appropriate documentation. Further model documentation which is really user documentation and is approriately placed under user documentation, is inexpicably duplicated at the top level on a par with developer and user documentation.

To Do:

• Need to remove the top level call to model documentation.
• Should make top level documentation the user documentation so users don't have to click twice
• Decide what to do about developer docs. Richard suggests putting them under user docs but this seems a bit obfuscational as it is NOT a user documentation. It is still available from the command line and can be raised with a browser by appropriate call to top level index. Further suggest we start pushing the docs build to the website so is available with loading SasView. Here the index would be the top level and have both user and developer docs as links.

to:

As noted by Richard Heenand during the !SasView 3.1 release testing phase as well as others, the top level tree gives user and developer documentation requiring the user to click twice to get to appropriate documentation. Further model documentation which is really user documentation and is approriately placed under user documentation, is inexpicably duplicated at the top level on a par with developer and user documentation.

To Do:

• Need to remove the top level call to model documentation.
• Should make top level documentation the user documentation so users don't have to click twice
• Decide what to do about developer docs. Richard suggests putting them under user docs but this seems a bit obfuscational as it is NOT a user documentation. It is still available from the command line and can be raised with a browser by appropriate call to top level index. Further suggest we start pushing the docs build to the website so is available with loading !SasView. Here the index would be the top level and have both user and developer docs as links.

[butlerpd]

Trac update at 2015/06/29 04:27:29:

• butler changed owner from "" to "butler"
• butler changed status from "new" to "assigned"

[butlerpd]

Trac update at 2015/06/29 04:29:28: butler commented:

Ok - so actually easier than I thought. Have dealt with first two issues. Moreover even in !SasView GUI from user docs you can click backward in toctree to top level and thence to developer docs. will leave this open for next release as a discussion: Do we want to make docs push to webpage?

[butlerpd]

Trac update at 2015/08/14 20:16:16: butler changed milestone from "SasView Next Release +1" to "SasView 4.0.0"

[butlerpd]

Trac update at 2016/03/06 19:10:29:

• butler commented:

I think this ticket should be closed. The issue of auto pushing the latest release docs to webpage should be a separate ticket though it is now part of the documented release process. Any new issues should generate a new ticket.

• butler changed resolution from "" to "fixed"
• butler changed status from "assigned" to "closed"