"User Manual" link somewhere in Gramps Web nav panel?

I would recommend a link to GrampsWeb.org somewhere in the nav panel. I’m working with some family members where I created accounts for them, sent them links to my Gramps Web instance and during the course of our orientation sessions over conference call, there were several “how do I do X” questions. If we weren’t on a conference call, then they could have, alternatively, seen the “user manual” or “help” button and located the information themselves, etc. The more family I involve, the more I could see this being of benefit. Of course good instructions need to be available and I do plan on contributing to the docs in that capacity through this ‘example exercise’ with my family. I also think they are a good use case for this class of user (browser-conversant, but not IT whizzes).

Yes, I agree.

One practical question is how to realize the UI for it - multilingual help tooltips would be quite a lot to translate. But we could just have a generic “open help page” or something button with a question mark icon that links to the appropriate page on grampsweb.org. Do you think that would work?

Yes I think a simple link to the “user guide” section of the docs would suffice. I’m actively working that section of the docs with a lot more user friendly “hand-holding” examples provided and link wording such that folks should be able to readily find answers and examples to what they want to accomplish. Below is a section I’m working on that explains the various record types they’ll be working with, etc.

Compared to the manuals I maintain for the X-Plane flight simulator, this is rather relaxing work :slight_smile:

2 Likes

@twkyler Tom,

Are you at a point where you can contribute some User Guide content? It doesn’t need to be comprehensive. Incremental improvements would be fantastic.

@DavidMStraub I would like to see a Gramps Web login help link at the bottom of the Login form. Not only would this help new users, it would identify the login screen as a Gramps Web site. (Since the URL will have an unpredictable domain name.)

We can improve the landing page at any time.

Can the hamburger menu offer a context sensitive help Link? It could have the URL change based upon the users Permission level. (If not, a Help link to https://www.grampsweb.org would be the lowest common denominator. More advanced users should be familiar enough with browsing to get to the right section.) This is an alternative to Issue 501: “suggestion for an icon in the App bar”

owner : https://www.grampsweb.org/administration/admin/
editor : no obvious entry point
contributor : no obvious entry point
member : https://www.grampsweb.org/user-guide/

I am not currently at such a point Brian, simply becaue the navigational framework change for the user guide was so comprehensive and not an ncremental changes to David’s original work. I created lots of placeholder “topic bin” files at the onset and am in ‘work in progress’ filling them out and they are all a bit symbiotic with cross-referenced links, so all need to be done together. In addition, the organization of files and topics is optimized for searching the most common phrases I expect folks may search for.

The work has been disrupted by a death in my immediate household, that between probate, cleaning up belongings and the holidays, has set the documentation work to side for the near term; however, I anticipate picking it up again shortly.

Some of the ‘topic bins’ can be incremental for sure and expanded on later, but I need to at least get a minimum of topics for the most common operations documented.

I will point out that all the work I’ve done since the last iteration is under the “user guide” link only, targeted at end users. I’ve made no changes to any of the other sections regarding installation or adminstration as that is squarely David’s domain IMO.

The image below shows the type of ‘topic bins’ that I think would be of benefit to end users. Most of these pages are still empty.

Tom, terribly sorry to learn of your loss.

Please think no more on this and focus on helping your family get through the holidays.