事前準備
- ヘルプセンターの管理権限が必要です。
手順
- Stories を開き、Notices を選択します。お知らせの一覧が表示されます。
- New を選びます。
- Title を入力します。
noticeKindで、Known issue、Announcement、Maintenance のいずれかを選択します。noticeStatusで、Open を選択します。- 任意:Summary、
affectedVersions、workaroundを入力します。可能であれば、読者に向けて回避策を案内してください。 - 任意:開始日時となる
startsAtを設定します。 - 適切なハブのセクションに配置し、公開します。
入力フォームには、完全な文章ではなく noticeKind などの短い名前でサポート項目が表示されます。
問題が解決したら:
- 該当のお知らせを開きます。
noticeStatusを Resolved に変更し、resolvedAtを設定します。- 保存します。
補足情報
- トップページのバナー: バナーには、対応中かつ「既知の不具合」または「メンテナンス」のお知らせが表示されます。通常のお知らせはバナーに表示されません。
- Order: 対応中のお知らせが開始日時の新しい順に先頭へ並びます。解決済みのお知らせはアーカイブとなります。
- ハブごと: 各ハブのページには、自身のセクションとトピックに属するお知らせが一覧表示されます。
- Workaround: 最大4,000文字まで入力できます。概要は最大600文字です。
- サイト上には「既知の不具合」という名称でお知らせの公開ページが用意されます。
トラブルシューティング
- 問題を解決したのにバナーが表示されたままになる:
noticeStatusを Resolved に変更して保存してください。 - お知らせがトップページに表示されない: 公開状態であること、Open になっていること、種別がお知らせ以外になっていることを確認してください。
よくある質問
よくある質問
サービスのリアルタイムの稼働状況も表示できますか?
はい、表示できます。ステータスウィジェットをご覧ください。
お知らせとリリースノートのどちらを使うべきですか?
現在起きていることや発生中の障害にはお知らせを使います。バージョンごとの変更内容にはリリースノートを使ってください。