Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Add support chatbot to docs site#582

Merged
nrichers merged 12 commits intomainvalidmind/documentation:mainfrom
add-zendesk-chatvalidmind/documentation:add-zendesk-chatCopy head branch name to clipboard
Dec 12, 2024
Merged

Add support chatbot to docs site#582
nrichers merged 12 commits intomainvalidmind/documentation:mainfrom
add-zendesk-chatvalidmind/documentation:add-zendesk-chatCopy head branch name to clipboard

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Dec 10, 2024 •
edited
Loading

Internal Notes for Reviewers

This PR adds the support chatbot to our docs site, along with an updated support page.

Chatbot integration

image

Updated support page

  • Updated heading
  • New section for opening support tickets
  • Updated margin note
  • (Same chatbot as now appears on all pages we build)

image

How chatbot integration works

A file that includes the Zendesk script snippet gets embedded in our Quarto profiles. As long as you are building with a profile, the chatbot will be there, on every page of the docs that we build (that's every page except the Python docs but those will be in Quarto soon).

How to test the chatbot locally

You need to preview or render the docs site with one of the profile that embeds the chatbot, e.g.

quarto preview --profile development --port 4444

External Release Notes

@nrichers nrichers added the infrastructure Docs infra changes label Dec 10, 2024
@nrichers nrichers requested a review from validbeck December 10, 2024 18:36
@nrichers nrichers added the internal Not to be externalized in the release notes label Dec 10, 2024
@github-actions
Copy link
Contributor

github-actions bot commented Dec 10, 2024

A PR preview is available: Preview URL

validbeck
validbeck approved these changes Dec 10, 2024
View reviewed changes
Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thanks for the quick assist Nik, way quicker than me bumbling around testing things first...

@nrichers
Copy link
Collaborator Author

nrichers commented Dec 10, 2024

Comment from @ValidSean that I will address:

image

@nrichers
Copy link
Collaborator Author

nrichers commented Dec 10, 2024 •
edited
Loading

Two additional changes:

  1. We didn't have a section that explicitly refers to opening a support ticket anywhere — especially important if you're just searching for related keywords — so I added one:

image

  1. Also, we had a margin note about getting help from a human via email that gets used in a couple of places, including on our main support page. This footnote now links to the new section rather than just calling out one method for getting help:

image

I also checked other references to using our support email and they make sense as-is.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 10, 2024

A PR preview is available: Preview URL

@validbeck
Copy link
Collaborator

validbeck commented Dec 10, 2024 •
edited
Loading

We didn't have a section that explicitly refers to opening a support ticket anywhere — especially important if you're just searching for related keywords — so I added one:

I mentioned this to Sean on the call (maybe after you left) but we are in agreement that the preference is to first send people to the help centre to log a ticket through the form as that enables users to view other tickets from their org if they are logged in.

@nrichers
Copy link
Collaborator Author

nrichers commented Dec 11, 2024

I mentioned this to Sean on the call (maybe after you left) but we are in agreement that the preference is to first send people to the help centre to log a ticket through the form as that enables users to view other tickets from their org if they are logged in.

I added the Help Center option, as suggested and also added a callout to say that this is the recommended option.

image

@github-actions
Copy link
Contributor

github-actions bot commented Dec 11, 2024

A PR preview is available: Preview URL

@validbeck
Copy link
Collaborator

validbeck commented Dec 11, 2024 •
edited
Loading

Nice! I just cleaned up the styling/wording a bit:

Screenshot 2024-12-11 at 11 07 31 AM

I tried using a preview tile, but Zendesk doesn't allow iframe embeds...

Screenshot 2024-12-11 at 9 35 44 AM

@github-actions
Copy link
Contributor

github-actions bot commented Dec 11, 2024

A PR preview is available: Preview URL

1 similar comment
@github-actions
Copy link
Contributor

github-actions bot commented Dec 11, 2024

A PR preview is available: Preview URL

@github-actions
Copy link
Contributor

github-actions bot commented Dec 11, 2024

A PR preview is available: Preview URL

@nrichers
Copy link
Collaborator Author

nrichers commented Dec 12, 2024 •
edited
Loading

Nice! I just cleaned up the styling/wording a bit:

I like the general idea of this! It probably falls into a pattern, but this change also introduced just a bit too many visual artifacts, so I did some cleanup (and fixed the wording for phone calls).

Before

image

After

image

@validbeck
Copy link
Collaborator

validbeck commented Dec 12, 2024

For email, they need to SEND from the address otherwise it won't auto-associate it with the right org in Zendesk — that's why I worded it that way.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 12, 2024

A PR preview is available: Preview URL

@validbeck
Copy link
Collaborator

validbeck commented Dec 12, 2024 •
edited
Loading

Also, I don't like the new layout. Harder to read for me.

What about:
Screenshot 2024-12-12 at 9 10 57 AM

@github-actions
Copy link
Contributor

github-actions bot commented Dec 12, 2024

A PR preview is available: Preview URL

@nrichers nrichers merged commit 45547ae into main Dec 12, 2024
@nrichers nrichers deleted the add-zendesk-chat branch December 12, 2024 17:20
@nrichers
Copy link
Collaborator Author

nrichers commented Dec 12, 2024

What about:

Looks good — merged so I can move on with my life. 😬

@validbeck validbeck mentioned this pull request Dec 12, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@validbeck validbeck validbeck approved these changes

Assignees

No one assigned

Labels

infrastructure Docs infra changes internal Not to be externalized in the release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@nrichers @validbeck
Morty Proxy This is a proxified and sanitized view of the page, visit original site.