buggNewSense GNU/Linux - Bugs: bug #39847, Wiki: "How to Get Help"...

 
 

bug #39847: Wiki: "How to Get Help" vs. "Get Help

Submitter:  Andrew R <andrewr>
Submitted:  Thu 22 Aug 2013 01:06:46 AM UTC
   
 
Category:  None Severity:  3 - Normal
Item Group:  Documentation Status:  Fixed
Privacy:  Public Assigned to:  None
Open/Closed:  Closed
* Mandatory Fields

Add a New Comment Rich Markup
   

Jump to the original submission

Sat 21 Dec 2013 06:41:18 AM UTC, comment #6: 

I don't think I can close this thing, but I can confirm that it is fixed.

Andrew R <andrewr>
Sat 21 Dec 2013 01:38:30 AM UTC, comment #5: 

This issue is fixed. Could someone close it, please?

-Deleted Account- <sirgazil>
Thu 22 Aug 2013 10:31:43 PM UTC, comment #4: 

As I already had created a Support page [5] when I created the Neighbours page [6], which is a child of Support, I took the liberty to structure it as I commented in my previous post. If you decide to use the Support page, someone with access to the server should update *galaxia.py* in the website theme, so that the Support menu points to the appropriate page:


def human_menu(self, d, **kw):
    """ Assemble easy to read main menu for the header

    @param d: parameter dictionary
    @rtype: unicode
    @return: page main menu html
    """
    html = [
        u'<ul id="human-menu">',
        u'<li><a href="/Download">Downloads</a></li>',
        u'<li><a href="/Documentation">Documentation</a></li>',
        u'<li><a href="/Support">Support</a></li>',
        u'<li><a href="/Development">Development</a></li>',
        u'</ul>',
    ]
    return u'\n'.join(html)


[5]: http://www.gnewsense.org/Support
[6]: http://www.gnewsense.org/Support/Neighbours

-Deleted Account- <sirgazil>
Thu 22 Aug 2013 06:24:38 PM UTC, comment #3: 

Actually, I do. I was already thinking what to do with them and submit a task to merge them. This is what I had in mind:

1. Create a Support page to replace Main/GetHelp.
2. Merge the HowToGetHelp and Main/GetHelp into the Support page. I think this would encourage users to help themselves first, before they look for help anywhere else.

So, the Support page would have two sections: System Help and Support; and Online Help. In the former we tell the user what's already written in HowToGetHelp. In the latter, we put the information about mailing lists and IRC that's already written in Main/GetHelp.

I have plans to review and update all documents listed in the Documentation set for gNewSense 3 [3]. I'm already finishing the task of updating the Installation Manual [4]. But I haven't created new tasks to document the changes.

3: http://www.gnewsense.org/Documentation/3
4: https://savannah.nongnu.org/task/?12774

-Deleted Account- <sirgazil>
Thu 22 Aug 2013 05:21:30 PM UTC, comment #2: 

I see what you mean. The titles make sense on their own, but they're in eachother's way. I think the current structure makes sense, because I believe the Documentation section is set up with standalone use (e.g. as a PDF) in mind, while Main/GetHelp is meant to be part of the website (i.e. the Support link at the top).

Another idea to solve the confusion is to rename Main/GetHelp to Main/Support. It also has the advantage of sounding more professional and pro-active. :)

Felipe, as the father of Documentation's structure, do you have an opinion on this?

Sam Geeraerts <samgee>
Group administrator
Thu 22 Aug 2013 01:12:38 AM UTC, comment #1: 

[Oops, accidentally submitted too early. Let's try again...]

The pages "How to Get Help"[1] and "Get Help"[2] might be confusing to users as they have similar titles, but different goals.

The first explains how a user can help themselves whereas the other page explains all of the support options. I propose that [2] links to "Self-help" as a subpage (if that's the correct terminology), i.e. a page under [2] in the breadcrumb heirarchy.

If nobody replies to this bug, I'll go ahead and make the change on the weekend.

1: http://www.gnewsense.org/Documentation/3/AboutgNewSense/HowToGetHelp
2: http://www.gnewsense.org/Main/GetHelp

Andrew R <andrewr>
Thu 22 Aug 2013 01:06:46 AM UTC, original submission:  


Andrew R <andrewr>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by sirgazil (Posted a comment)
  • -email is unavailable- added by samgee (Posted a comment)
  • -email is unavailable- added by samgee
  • -email is unavailable- added by andrewr (Submitted the item)
  •  

    Follow 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2013-12-23 samgee StatusNone Fixed
        Open/ClosedOpen Closed
    2013-08-22 samgee Carbon-Copy- Added -email is unavailable-

    Back to the top

    Powered by Savane 3.13-f8d8.
    Corresponding source code