Skip to content

Provide contextualized, prefilled support forum link to ask for help #4915

@rtibbles

Description

@rtibbles

This issue is not open for contribution. Visit Contributing guidelines to learn about the contributing process and how to find suitable issues.

Desired behavior

The Learning Equality community forums are the primary place to seek support with Kolibri Studio. We do currently link to this in the side panel navigation, but if you are having issues with a specific channel, the context is lost.

Once #4914 is fully implemented, we will have a mechanism to provide a redirect link for Kolibri Studio administrators to offer support to users who post on the forum.

Using the functionality described here: https://meta.discourse.org/t/creating-a-link-to-start-a-new-topic-with-pre-filled-information/28074 we can add the ability to direct a user to a prefilled forum post to seek help.

In order to accomplish this, there should be a new help icon button (using the KDS help icon: https://design-system.learningequality.org/icons#token-help) displayed in the top left buttons, to the right of the edit button here:

Image

When this button is clicked, a modal will appear (using the KModal component). In that modal will be a link to the Kolibri Studio documentation with the text "Read the Kolibri Studio documentation". This should be indicated to be an external link (like the link to the documentation in the side navigation) and open in an external window.

Below this link in the modal should be a text box with the label prompt "Briefly describe your issue", and another larger text box with "Add additional details".

At the bottom of the modal will be a primary action button that will open a new window with the prefilled forum link for the Kolibri Studio support forum (https://community.learningequality.org/c/support/studio).

The title will be prefilled with the contents of the first text box (Briefly describe your issue), and the body of the post will be prefilled with the following:

Channel link: <channel redirect link from #4914>

Description of issue: <Contents of "add additional details">

The user will then be able to further edit their post before posting.

There should also be a secondary action button saying "Close" to dismiss the modal.

Technical details

The modal will need to load (or automatically generate and then load) the support link using the API defined in #4914. While that API interaction is happening, the primary action button should be disabled.

It is important that the post opens only in the studio subsection of the community forum, so care must be taken to follow the details of the Discourse API above.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions