refactor: replaces dashboard tab docs with link to openedx-aspects docs

[pomegranited]

Moves the lengthy text descriptions out of the Dashboards and Charts and replaces them with deep links into the openedx-aspects reference documentation.

The Help markdown is configurable for each of the Operator and Instructor Dashboards, or the Help tab(s) may be omitted entirely by setting:

# Hide Instructor Dashboard Help tab
tutor config save -s ASPECTS_INSTRUCTOR_HELP_MARKDOWN=""

# Hide the Operator Dashboard Help tab
tutor config save -s ASPECTS_OPERATOR_HELP_MARKDOWN=""

Screenshots

References

ref #169

Related to openedx/openedx-aspects#100

[openedx-webhooks]

Thanks for the pull request, @pomegranited! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

• supporting documentation
• Open edX discussion forum threads
• timeline information ("this must be merged by XX date", and why that is)
• partner information ("this is a course on edx.org")
• any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

[pomegranited]

@bmtcril @Ian2012 I've replaced the markdown on the Instructor Dashboard tabs with a "Reference" link to the docs added by openedx/openedx-aspects#100. What do you think? Any tweaks? Once we're happy with it, I'll do the same to the Operator Dashboard tabs.

[bmtcril]

I think we need a way to turn the links off entirely, and maybe some light help text should remain explaining what filters are required until we can fix that bug. I'm not sure how useful a configurable root url is if we have fixed paths appended to it, but I definitely don't want to have a per-chart setting either. Maybe the reference link is just at the dashboard level? 🤔

[pomegranited]

@bmtcril

I'm not sure how useful a configurable root url is if we have fixed paths appended to it, but I definitely don't want to have a per-chart setting either. Maybe the reference link is just at the dashboard level? 🤔

Ok, how about a Help tab for each Dashboard instead (see updated image above)?

I think we need a way to turn the links off entirely

2d931f8 makes the content of that tab configurable in case institutions have their own links they want to use. It also allows the Help tab to be omitted by setting ASPECTS_HELP_MARKDOWN = "".

I'm also happy to change this to hard-coded Help text and an on/off flag if you prefer.

maybe some light help text should remain explaining what filters are required until we can fix that bug.

Sure, I've reinstated the help text about using filters.

A workaround for this issue could be to set "select first filter value by default" for the required filters:

[bmtcril]

@crathbun428 may have some more thoughts but I think this is a good start. I'd say that we can probably have a "dashboards" landing page in the docs so they don't get dumped into the whole technical internals of the system, but that can be a follow on.

Sadly "Select first filters by default" is buggy right now (it doesn't correctly clear / update based on the parent values, sometimes showing things like courses and problems that the user doesn't have access to). I'm working on a funded contribution that may including fixing it.

[pomegranited]

Thank you for your comments @bmtcril & @crathbun428 ! How's it looking now?

I'd say that we can probably have a "dashboards" landing page in the docs so they don't get dumped into the whole technical internals of the system, but that can be a follow on.

I've linked to the specific reference page for each dashboard, see a11a0e0. These pages will be populated by openedx/openedx-aspects#100.

Sadly "Select first filters by default" is buggy right now...I'm working on a funded contribution that may including fixing it.

Oo, I'd love a chance to contribute to Superset! Will keep an eye out.

[crathbun428]

@pomegranited - This looks good to me! (FYI - @bmtcril)

[openedx-webhooks]

@pomegranited 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.