Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make it clear where partners can go for help with tech problems #2146

Closed
5 tasks
katjam opened this issue Nov 23, 2023 · 4 comments · Fixed by #2390
Closed
5 tasks

Make it clear where partners can go for help with tech problems #2146

katjam opened this issue Nov 23, 2023 · 4 comments · Fixed by #2390
Assignees
Labels
verified Issues that have been user acceptance tested vvv Very Very Valuable
Milestone

Comments

@katjam
Copy link
Member

katjam commented Nov 23, 2023

User story

As a person running into problems setting up a new calendar or organisation, or feeling something is not quite right, I need to know the paths to common fixes and when to call for help.

Raised off the back of #2094

Acceptance Criteria

  • on each page of the admin UI non-root users can access the following:
    • Link to handbook
    • Link to support email
    • Link to Discord
    • Link to report a bug on Github

implementation plan

based off Kim and Ivan's suggestions I think we should make use of the sidebar nav to have help available on each page.

For non-root users we can use the space of "In development" and assume that root users are the people who would be giving the help or at least already know how to find resources.

image

@katjam katjam changed the title Create a tech support flowchart for organisers Make it clear where partners can go for help with tech problems Jan 15, 2024
@katjam katjam added the vvv Very Very Valuable label Apr 8, 2024
@r-ferrier r-ferrier added the requires research Is this still an issue? What are viable solutions? label Apr 9, 2024
@ivan-kocienski-gfsc ivan-kocienski-gfsc self-assigned this Apr 10, 2024
@kimadactyl
Copy link
Member

kimadactyl commented Apr 10, 2024

Could literally just be a link to the handbook, a link to the discord, and the support@ email in a nice big box on the dashboard index?

@ivan-kocienski-gfsc
Copy link
Contributor

Hmmm. That does sound good -

Possible approaches:

  • Have one help button on the title bar / main nav that links to a handbook page for the entire admin interface (least code effort)
  • Have a help button on each page that links to a page in the handbook that covers that part only
  • Have lots of small "help" buttons throughout next to various things (like the calendar strategy picker) that explains those specific parts.

@ivan-kocienski-gfsc
Copy link
Contributor

If we are going with the second option then:

The A/C would be help pages and links for

  • Logging in page (overkill?)
  • Dashboard
  • Partners index and new/edit
  • Calendars index and new/edit
  • Users index and new/edit
  • Sites index, show and new/edit
  • Tags index and new/edit

Things non-root people should be hidden from:

  • Articles
  • Collections
  • Supporters
  • Importer status (although this may be useful for internal documentation)

@ivan-kocienski-gfsc ivan-kocienski-gfsc removed their assignment Apr 11, 2024
@aaaaargZombies aaaaargZombies self-assigned this Apr 11, 2024
@aaaaargZombies aaaaargZombies removed the requires research Is this still an issue? What are viable solutions? label Apr 11, 2024
@ivan-kocienski-gfsc ivan-kocienski-gfsc added the verified Issues that have been user acceptance tested label Apr 24, 2024
@ivan-kocienski-gfsc
Copy link
Contributor

Verified on staging (although the email address is not a link?)

See "GET SUPPORT" section in side panel

Screenshot_2024-04-24_10-31-28

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
verified Issues that have been user acceptance tested vvv Very Very Valuable
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants