Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Log in to Zendesk.
  2. In the upper right corner, select  , then select Guide. The Themes page appears.
  3. In the upper left corner, select Add, then select Article (or category or section). 
  4. In the left hand pane, enter the article title and content. Use the appropriate formatting options for the article type. For information on formatting, see Style guidelines for help articles in Guide, in the edX brand. You must be logged in to Zendesk to view this article.
  5. In the right hand pane, enter the following:
    1. Under Publish in section, select the category and section that the article will appear in. 
    2.  Deselect the checkbox for Open for comments. Note: This is selected by default. This allows commenting on articles that we are presently not staffed to moderate. 
    3. If desired, select the checkbox for Promote article. Promoted articles appear at the top of any menus and article lists and typically address common questions. Promoting articles helps surface content that may otherwise be lost in alphabetical lists or other section hierarchies.
  6. Select Save. This saves, but does not publish, your article.
  7. Verify and test the article in both the current and in-development themes. Note that testing the documentation is required. 
    1. Test the current theme: On the article editor page, select Show in Help Center to launch the article in the current theme; this shows how the article will be formatted and appear when published and live in the help center.
    2. Test the in-development theme: On the left of the screen, select Customize design. Under Custom themes, select View theme. This will load the in-development theme on any currently opened help articles, as well as any you open after loading the theme. Note that this does not publish the theme, or change any formatting to the currently live help center site.
      Note: Article styling, especially if you've copied in content from another source or document, will not always display as expected. You may have to select Source code  , located in the editor toolbar, to adjust the formatting, or reformat the text within the editor window.
  8. When the styling and content have been tested and revised if necessary, select the dropdown arrow next to Save and select Publish.
    This automatically publishes the article and adds it to the live help center in the category and section that you set.

...