How do I tell readers about a known issue, maintenance or news?

Before you start

• You need permission to manage the help centre.

Steps

1. Open Stories and choose Notices. This opens the list of notices.
2. Choose New.
3. Fill in Title.
4. In noticeKind, choose Known issue, Announcement or Maintenance.
5. In noticeStatus, choose Open.
6. Optional: Summary, affectedVersions and workaround. Give readers a way around the problem if you can.
7. Optional: startsAt, the time it starts.
8. Put it in the section of the right hub, then publish.

The form shows these support fields by their short names, such as noticeKind, instead of full sentences.

When the problem is fixed:

1. Open the notice.
2. Change noticeStatus to Resolved and set resolvedAt.
3. Save.

Good to know

• Home banner. The banner shows notices that are open and are a known issue or maintenance. Announcements do not appear in the banner.
• Order. Open notices come first, newest start first. Resolved notices form the archive.
• Per hub. A hub's page lists the notices of its own section and topics.
• Workaround. It can be up to 4,000 characters. The summary can be up to 600.
• Your notices have a public page called Known issues on your site.

Common problems

• The banner still shows after I fixed the issue. Set noticeStatus to Resolved and save.
• The notice isn't on the home page. Check that it is published, Open, and not an announcement.

Questions

Related

• Status widget
• Release notes
• Help hubs
• Help centre and product docs