Embed Freshdesk contact form into support docs and reword a little

[sgibson91]

fixes https://github.com/2i2c-org/meta/issues/452

[sgibson91]

So the widget isn't showing in the build preview: https://2i2c-pilot-documentation--180.org.readthedocs.build/en/180/support.html

@choldgraf Do I have to do anything special to get sphinx and html working together?

[sgibson91]

Maybe I have to define the button? I thought that would have come with the embed code though https://support.freshdesk.com/en/support/solutions/articles/50000001015-launching-the-widget-when-a-button-is-clicked

[choldgraf]

HTML should work, but I wonder if you need to have a space between it and the comment? I think in markdown, HTML elements need to have space around them to let the parser know theyre different from markdown

[sgibson91]

Hmmm, I don't think that worked :-/

[choldgraf]

It looks like it worked to me - the docs you linked suggest that the button exists in the bottom right of the screen, and I do see that in the preview:

The first step of the docs you linked also suggest we need to create our own button if we want people to click something to open the menu other than clicking the hover button in the bottom right:

I added a little HTML button snippet following the docs they recommended in that article and pushed in the latest commit. It should work if you click it, but people should also be able to click the little "help icon" in the bottom right too.

Question

Should we put that help icon in the bottom right on every page rather than just the support page?

[sgibson91]

Ok.... why don't I see it?!

[sgibson91]

Clicking the HTML button you added also does not open anything for me, so I'm guessing there's something not compatible about my browser

[sgibson91]

Ok, PrivacyBadger was blocking the pop-up on my browser. So we may need to add a warning for people to check their browser privacy settings if they don't see the Help button?

[sgibson91]

Should we put that help icon in the bottom right on every page rather than just the support page?

I don't think this is a terrible idea BUT I'm not sure how to implement it without copy-pasting that snippet onto every single page, and remembering to add it to every new page we add. So I think that is a stretch goal we should reserve for later on in the development.

[choldgraf]

Want me to give it a shot quickly? I think it should be doable with a little sphinx-foo

[sgibson91]

@choldgraf Sure, if you think you can do it! I am lacking on sphinx-foo 😄

[choldgraf]

OK I think the last commit adds the JS to each page. I also tried to document things so it's clear where they come from

[sgibson91]

Amazing! It works for me!

[sgibson91]

I will have lunch and then add a note about browser privacy settings, then I will mark this PR as ready to review