GNOME Bugzilla – Bug 670527
Help needs updates and improvements
Last modified: 2014-01-28 00:36:12 UTC
The baobab user help was ported from DocBook to Mallard in bug 658377, the port was basic and needs more work. TODOs: - scan-remote.page needs to be finished - troubleshooting pages need to be finished - *.stub pages need to be finished, merged into other pages or deleted - all quoted out text should be merged into the page that it is on, or deleted
Do we want to have a help component in Bugzilla?
sounds like a good idea
I added it and set the default assignee to gnome-user-docs-maint@gnome.bugs
Thanks Paolo. The help has just been updated for 3.8, it would have been nice to have a bug after the redesign as we *ahem* missed it. Is any UI or functionality changing for 3.10? scan-remote.page is now finished, but we need a page or section about the possible URLs for the "connect to server" dialog. We could also do with some "How do I…?" pages.
For the "connect to server" dialog, wouldn't it be better to document it directly in the gnome-user-docs module (as I did find now) and provide a link pointing there ? Also I plan to add a page about common problems (like the error we get when some files weren't scanned or slow scan).
Created attachment 267218 [details] [review] Add list of supported protocols and example For now let's add that here but I guess it would better to provided a help topic for nautilus-connect-server in the gnome-user-docs
Created attachment 267219 [details] [review] Add common problem sections and related pages Add pages about slow scan and permissions problems.
Review of attachment 267218 [details] [review]: Can you create a new page for supported protocols instead of adding it to scan-remote? Please use one of the other pages as a template. I think that's the best place to explain the address syntax as well. You should also add a license for the new page and I will work on adding one for the old pages.
Created attachment 267262 [details] [review] Add common problem sections and related pages Add pages about slow scan and permissions problems.
Created attachment 267284 [details] [review] Add a link to the list of supported protocols
The latest patch removes the example for the scan-remote.page and adds a link to the documentation that already exist in gnome-user-docs.
Created attachment 267286 [details] [review] Add common problem sections and related pages Add pages about slow scan and permissions problems.
and This patch adds the license
Review of attachment 267218 [details] [review]: obsolete
Created attachment 267295 [details] [review] Add a link to the list of supported protocols
Created attachment 267296 [details] [review] Add common problem sections and related pages Add pages about slow scan and permissions problems.
Review of attachment 267296 [details] [review]: ::: help/C/problem-permissions.page @@ +14,3 @@ + + <desc>About the message "<gui>Could not scan /… or some of the folders + it contains</gui>"</desc> What about something like "I see a <gui>Could not scan /… or some of the folders it contains</gui> error message when scanning." @@ +17,3 @@ + + </info> + Could you add a note to specify that df is used for the main window results and du is used for the detailed view? @@ +18,3 @@ + </info> + + <title>Permission problem reported during the scan</title> Maybe "Error when scanning"? ::: help/C/problem-slow-scan.page @@ +14,3 @@ + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/> + + <desc>On why scanning a folder or a remote location is slow</desc> Maybe have a short "Scanning depends on the media that you are scanning." @@ +22,3 @@ + speed of the media you're scanning. For instance a mechanical hard drive will + be slower than a SSD, and scanning a remote directory over Internet will + generally take longer than scanning a folder over a local network.</p> <p>The Break line between paragraphs.
Created attachment 267333 [details] [review] Add common problem sections and related pages Add pages about slow scan and permissions problems.
commit 8d1b328092098b1c38db469eaa9f5dd81161cd22 Author: Baptiste Mille-Mathias <baptiste.millemathias@gmail.com> Date: Sun Jan 26 12:23:15 2014 +0000 Add common problem sections and related pages Add pages about slow scan and permissions problems. commit 30cc2882ec813b11e0d0f7bfeaa9e924518868e9 Author: Baptiste Mille-Mathias <baptiste.millemathias@gmail.com> Date: Sun Jan 26 11:35:36 2014 +0000 Add a link to the list of supported protocols