Support Doc Engine

Use the Support Doc Engine to create support documentation for your customers. This tutorial will show you how to create a new support doc.

Screen_Shot_2013-07-15_at_3.04.26_PM.png

 

1. Click on the CMS tab.

Screen Shot 2013-07-08 at 11.59.16 AM.png

 

2. Click on the Support Doc Engine menu item.

Screen_Shot_2013-07-15_at_3.09.21_PM.png

 

3. Click on the Add support article button.

Screen_Shot_2013-07-15_at_3.09.35_PM.png

 

4. Write a Title for your support article.

 Screen_Shot_2013-07-15_at_3.09.49_PM.png

 

5. The Slug is used to construct the URL for this support article.

Screen_Shot_2013-07-15_at_3.09.56_PM.png

 

6. Write the content of your article in the Body text box. You can HTML or Markdown text.

Screen_Shot_2013-07-15_at_3.10.07_PM.png

 

7. You may also provide a product version associated with this document.

Screen_Shot_2013-07-15_at_3.10.15_PM.png

 

8. Checkmark to activate this article.

Screen_Shot_2013-07-15_at_3.10.22_PM.png

 

9. Select a topic from the dropdown list or create a new support topic by clicking on the green plus icon.

Screen_Shot_2013-07-15_at_3.10.40_PM.png

 

10. Select the sites where this article will be shown. 

Screen_Shot_2013-07-15_at_3.10.48_PM.png

 

11. Checkmark to have this article Featured.

 Screen_Shot_2013-07-15_at_3.10.59_PM.png

 

12. Select the products this article applies to. 

Screen_Shot_2013-07-15_at_3.11.04_PM.png

 

13. Select the Order in which this support article will be shown on the list or articles. Articles with lower order values will be shown first.

Screen_Shot_2013-07-15_at_3.11.13_PM.png

 

14. Add images using the Support Images section. To place images on your article (Body text box) use the image key surrounded by brackets ( e.g. {{ my_image_key }} ).

Screen_Shot_2013-07-15_at_3.11.58_PM.png

 

15. Provide a key for your image. The key is a unique string preferably lowercase with letters, numbers and dashes only.

Screen_Shot_2013-07-15_at_3.48.39_PM.png

 

16. Write a caption for this image.

Screen_Shot_2013-07-15_at_3.48.45_PM.png

 

17. Click on the Choose File button to select an image from your computer.

Screen_Shot_2013-07-15_at_3.48.50_PM.png

 

18. More images can be added using the Add another Support Image button.

Screen_Shot_2013-07-15_at_3.21.39_PM.png

 

19. Videos can also be added to your article using the Support Videos section. To place the videos on your content use the key for this video surrounded by brackets (e.g. {{ my_video_key }}).

Screen_Shot_2013-07-15_at_3.12.43_PM.png

 

20. To embed a video from YouTube or Vimeo add the share link in the Oembed code text field.

Screen_Shot_2013-07-15_at_3.17.26_PM.png

 

21. If you prefer to load a video located on your computer click on the Choose File button. There are no files size limits but there is a 30 second time out.

Screen_Shot_2013-07-15_at_3.17.32_PM.png

22. Click on the Choose File button to load a Thumbnail for this video.

Screen_Shot_2013-07-15_at_3.17.37_PM.png

23. Write a caption for this video.

Screen_Shot_2013-07-15_at_3.48.45_PM.png

 

24. Provide a key which should be a unique sting preferably lowercase with letters, numbers and dashes only.

Screen_Shot_2013-07-15_at_3.17.47_PM.png

 

25. Click on the Add another Support Video button to add more videos as needed.

Screen_Shot_2013-07-15_at_3.17.55_PM.png

 

26. Save.

Screen Shot 2013-06-24 at 1.22.22 PM.png

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk