User Guide Improvements and Updates

[forman]

From @forman on June 30, 2017 7:58

Input from Helen:

Below are points which I think it will be helpful to put in the User Guide. These are based on my experience with the GUI as a new user.

Installation

• Explain about the SSL “certificate verify failed” error with Windows and that the workaround is to open https://esgf-index1.ceda.ac.uk/projects/esgf-ceda/
• Tell the user how to uninstall cate
• Tell the user how to update a cate installation to a later version.

Opening datasets

• Mention that you cannot double double-click on a data source to open it. You have to select the “open data source” button, or “copy data to local” button.
• In “Open Dataset” window. Explain that the time constraints are set by default depending on the contents of the data source. If the user tries to make the start time earlier than the default, or the end time later than the default, then this will be rejected and it will go back to the default.
• In “Open Dataset” window. Explain what it means when the Time Constraint is displayed as “out of range”
• In “Open Dataset” window, when opening calendar. Explain that the past week, past month etc on the left hand side refers to the current date (at least, I presume it does?). So if user tries to select “last six months” but the data source ends in 2012, then nothing will be selected.
• Warn user that datasets may take a long time to load and that is why it is important to set time and region constraints. Also that it is a good idea to copy datasets to local.

Workspaces

• Explain that the user can rename resources, and how to do this
• In Workspace, under Details, explain that the user can adjust the column width to display all of the text
• Explain how to save a workspace and that you need to create an empty folder.
• Remind user to save the workspace before closing cate, or it will be lost.

General

• I find it helps to keep the Tasks list open so I can see what is happening

Copied from original issue: CCI-Tools/cate-desktop#29

[forman]

@HelenClifton if your time allows for, it'd be nice if you could check if your TODO items are still applicable or if there are new ones?

[HelenClifton]

@forman Having looked at the points above, most have either already been added to the User Guide or are no longer applicable. Just a couple still to add:

• mentioning the workaround described in Issue with updating cate version on Windows #428, in the case where the user is updating cate version on Windows.
• mentioning that if the user wishes to save the workspace, this needs to be done before exiting cate
• I also suggest adding a mention of the new "CCI Tools" forum you've just set up. This could go in section 11 (Support).

[forman]

@HelenClifton thanks, good points!

[forman]

@HelenClifton it'd be nice if you simply check, what is already addressed, thanks!

[HelenClifton]

@forman I don't have permission to edit the top comment