It would be nice to have help available that's relevant to wherever a user finds herself. I recently created a simple Feature to provide something along these lines: Contextual Help.

Contextual Help keeps help content in nodes, with a field specifying the path for which the help is relevant. It then exposes a Views block that lists contextual help nodes filtered to those relevant to the page the block is being displayed on. Clicking on any of these links will display the contextual help in an overlay. A link to add new content relevant to a given page is also provided.

The main benefit, as I see it, is that knowledgeable end-users can easily contribute back new or improved documentation by re-exporting the feature with additional content via features_uuid. Alternatively, site-specific contextual help can be added independently of Aegir-specific help content.

So I'd like to create a (contrib?) aegir_contextual_help module to integrate into the Aegir3 UI, and provide Aegir-specific content.

Comments

ergonlogic’s picture

ergonlogic
he/him
Primary language English
Location Montréal, Québec 🇨🇦
CreditAttribution: ergonlogic commented

By the way, I added a corresponding issue in the Contextual Help queue: #2107407: Integrate with Aegir3

ergonlogic’s picture

ergonlogic
he/him
Primary language English
Location Montréal, Québec 🇨🇦
CreditAttribution: ergonlogic commented
Status: Active » Postponed

Contextual help itself is coming along nicely. But there won't be any need to figure out a good place to integrate it into the Aegir UI until 3.x becomes the focus.

BTW, I've moved to using a ctools modal dialog, which allows us to have a help pop-up over an open overlay. Since it only depends on ctools, which is required by Views, it doesn't introduce any new dependencies on that front.