English (US)
  1. Zendesk help
  2. Guide
  3. Using Guide for help center
  4. Working with articles in the knowledge base

Promoting an article to the top of the section

Jennifer Rowe
  • Edited
Zendesk Documentation Team

What's my plan?

Suite allall plans

You can promote articles in a section to draw attention to them. When you promote an article, it moves to the top of the articles list within its section and has a star beside it.

Promoted articles always appear at the top of the section, regardless of the sorting option chosen. Promoted articles might also appear by default on the home page, depending on your theme.

To promote an article

  1. Navigate to the article, then click Edit article in the top menu bar.

  2. Click Promote article in the article's sidebar.

  3. Click Save.
Return to top

16 Comments

  • Christopher Boerger

    Hey it would be great to be able to bulk edit all articles and add or remove the promote article option. 

    weird that you cannot act on all article settings when bulk editing. 

    1
  • Slava Skorbezh

    Hi, any plans to add top of the articles list to Support SDK for iOS/Android?

    0
  • Cheeny Aban
    Zendesk Customer Care

    Hi Slava Skorbezh,

    Thank you for leaving feedback on our Community. I've marked this comment as Product Feedback. We truly value customer feedback and your voice and votes in the product feedback topics in the community help influence future Zendesk functionality.

     

    1
  • Soo Hian Foo
    • Edited

    Hi Jennifer Rowe ,

    thanks for sharing about promoting articles for Guide (help center).

    We would like to show our most popular articles based on the highest number of page views, in our header dropdown and some sections in our Guide web pages.

    Is there a way to automate it instead of manual promotion? Like a template?


    5
  • Soo Hian Foo

    Hi Cheeny Aban

    Can you help re: this:

    We would like to show our most popular articles based on the highest number of page views, in our header dropdown and some sections in our Guide web pages.

    Is there a way to automate it instead of manual promotion?

     

     

    4
  • Slava Skorbezh

    +1 to Soo Hian Foo comment. It'd be great to have such a feature

    2
  • Rebeca Hernandez

    +2 to Soo Hian Foo request

    0
  • Rebeca Hernandez

    An additional question, it is mentioned above, "Promoted articles might also appear by default on the home page, depending on your theme." how to know which theme would enable this? it would be extremely helpful to have this on the help center, thanks

    0
  • Christine Felicia
    Zendesk Engineering
    Hi Rebeca,

    We have an existing thread with recommendations from Team Diziana on this community post.
     

    Just copy and paste the below code at your home_page.hbs at the bottom and you can see all your promoted article would be showing on homepage:

     

    {{#if promoted_articles}}
          <section class="articles">
            <h2>{{t 'promoted_articles'}}</h2>
            <ul class="article-list promoted-articles">
              {{#each promoted_articles}}
                <li class="promoted-articles-item">
                    <a href="{{url}}">
                      {{title}}

                      {{#if internal}}
                        <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" focusable="false" viewBox="0 0 16 16" class="icon-lock" title="{{t 'internal'}}">
                          <rect width="12" height="9" x="2" y="7" fill="currentColor" rx="1" ry="1"/>
                          <path fill="none" stroke="currentColor" d="M4.5 7.5V4a3.5 3.5 0 017 0v3.5"/>
                        </svg>
                      {{/if}}
                    </a>
                </li>
              {{/each}}
            </ul>
          </section>
        {{/if}}

     

    Note: The above promoted article code can be found in default Copenhagen Theme at Homepage file.

     
    Hope this helps!
    0
  • Christina Hernandez

    How can you change the Promote star icon to something else? Thanks! 

    0
  • Christine Felicia
    • Edited
    Zendesk Engineering
    Hi Christina,

    You can change the icon that appears before the article title, however, you will need to make some advanced customization on the theme code. Please be advised that our team is unable to provide support for custom coding, you may reach out to your Developers or IT team for guidance on how to tweak the theme code.

    Sharing with you this response I found on this post from Team Diziana (they're third-party Developers, and provide assistance with theme customizations) the answers on the post might give you an idea of where to make changes to the code.

    Thanks!
    1
  • Zoe

    I've added the promote functionality and my promoted articles appear on my homepage which is great. What I've noticed is that my side navigation is showing the promoted articles at the top of the menu, confusing the order in which the articles should be read. 

    Is there a way to have the promoted articles displayed on the homepage but for it not to impact the order anywhere else? This is quite a big problem for our workflows.

    I also have another question regarding the star that's meant to appear next to the article; this doesn't show in my help centers - any idea as to why not?

    Thanks

    1
  • Syd Stahler

    I also have the same question as Zoe!

    0
  • Vlad
    Community Moderator
    The Wise One - 2022

    Zoe Syd Stahler

    just working on my client's help center and found it IS possible to sort articles by position, regardless if some of them are promoted articles or not. You can do that using ZD's API sort option (sort by position). More details:
    https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#sorting

     

    0
  • Zoe

    Hi, I'm a Product Writer, not a Developer/Engineer, so I don't have much technical knowledge. Is this straightforward to implement, or do I need to seek technical support?

    Thanks.

    0
  • Vlad
    Community Moderator
    The Wise One - 2022

    Yes, frontend dev would be needed.

    0

Please sign in to leave a comment.

Related articles

Powered by Zendesk