By Peter Martin on 2017-05-11 23:49 in GSoC 17 Refactoring help screen on JDocs

Date: 10th May 2017
Time: 16:00 (UTC / GMT)
Meeting was attended by: João Reys Santos, Peter Martin, Sandra Thevenet, Shivam Rajput, Tom Hutchison, Yves Hoppe

Topics:

1. Discussing the most needed features with detail

1. Creating a tour guide for new administrators

Tom suggested to use http://introjs.com Yves suggested http://linkedin.github.io/hopscotch/ and Shivam suggested http://bootstraptour.com/. Shivam will investigate some of those JS libraries regarding functionality & license.

We have discussed about different implementation and a non-obtrusive button next to the [help] button in the toolbar seems the best solution. Shivam will investigate how to create a plugin to use the help texts, e.g. using JSON.

Shivam will make a selection of the most important fields for the tour guide (and not use all fields), and start with implementing it in one com_content Articles view, making it more generic later on so that other places (and 3rd party extension developers) can use the same method in their components.

2. Displaying the content of the Help Screen

Using the back-end administrator language to retrieve the right language help text (by default in EN, but if another language is used, in that language by adding “lang=x” to helpfile URL)

3. Making JDOCS more manageable

Shivam suggested to set up a bot at the JDocs wiki.

Tom suggested to focus on #1, and if there’s time left on #2.

2. Setting up initial tasks for community bonding

Shivam should write a blog post to introduce himself and his project. That way it will be easier for him to get help from other people in the project because they can read about his project + goals.

3. Reviewing timeline

[for next meeting]