Knowledge Base/Community Help, Tips & Tricks

Making Zendesk Tutorials Embeddable

Tia Marie
posted this on April 12, 2012 03:05 pm

Repost This

As a Community Manager, one of the repetitive tasks I have is writing product documentation. Making sure my community knows how to use the product I work on is a pretty important task, and even more important is making sure that you don't have to worry about keeping multiple copies of your documentation up to date.

We use a help desk and support platform called Zendesk. I write all of our community support documentation there, but to keep things pretty, I use Repost.Us to make the articles embeddable. Since our tutorials and help desk are Repost.Us enabled, this means that I have a single place to update documentation, and I don't have to worry about updating multiple pages. Another great thing this does is allow anyone to take the help documents I've written and post them to their sites.  One thing I hate to worry about is blogs and media outlets covering the product I work for and citing documentation that becomes old when features are added. Now that you know why this is a good idea, let me show you how I do it.  

 

Step 1: Make sure you have  a Zendesk account and a Repost.Us account

Step 2: Set your help desk up with Repost.Us Site information & Selectors

 

Host_Info.png

Add your basic site information about your support desk.  


Selectors.png

Don't forget to add the CSS selectors!  We use a very basic style for our help desk and don't have any customised CSS selectors.  These may work for you: h3.entry-title for the Article Title and .user_formatted for the Article Body. 


Step 3: Get the install scripts from the Repost.Us Installation section and paste the second script into a new "Global JavaScript" widget in Zendesk. Also paste the second script into a new global javascript widget that is set available for "Anyone, including people who have not logged in." Make sure it's saved and activated

HEAD.png

 

Widget.png

 

Step 4: Write your article and add the button code to it.  

 

Button.png

Note: This is the exact HTML I use to put in every post. Also add the repost.us javascript with it.  For some reason, Zendesk's forum wants to see this in two places before it'll handle this correctly.  Below is what I use on our Zendesk support articles to make a Repost.us button show up in the upper right hand side of the article, like this.

<script src="http://static.1.rp-api.com/rjs/repostus.js" type="text/javascript"></script>
<p><a class="rpuRepostUsButton" href="https://secure.repost.us/syndicate/create"><img style="float: right;" title="Repost This" src="http://secure.repost.us/images/button-article-sml.png" alt="Repost This" border="0" /></a></p>


Step 5: Publish your article and repeat! You're going to need to add a button to every article, which is why I just paste the button script from step 4 at the very top of all of my articles. I can copy and paste them again into a new article easily without having to go back to Repost.Us every time.

 

 
Topic is closed for comments