このページでできること:使えるドキュメントのスペースがあり、タイトルと公開の入口が正しい。
ディレクトリと記事は フォルダとページを追加する。
場所
ドキュメントのサイドバーから、まず スペース一覧(/admin/docs)。説明は、スペースを作り、管理する、という内容です。タイトルを開くとディレクトリとページに進みます。
空のときは、ドキュメントのスペースがまだ無い、と出ます。右上でスペースを追加します。スペース名で検索できます。検索していないときは、ドラッグで並べ替えできます。
スペースを追加する
- スペースを追加する(
/admin/docs/spaces/new)。説明は、タイトルと slug を入れ、保存したあと文書ツリーでルートのフォルダとページを足せる、という内容です。 - 下の表を入れて保存する。
| 欄 | 説明 |
|---|---|
| タイトル | 管理画面と公開サイトのスペース名 |
| URL スラッグ | 既定以外のスペースはパスに出る。例:/docs/product の product。小文字の英字、数字、ハイフン |
| 概要 | 任意。公開のスペース切り替えと、既定の概要カードに出る |
| アイコン | 概要と切り替えに出る小さな図 |
- 一覧に戻り、タイトルを開いてそのスペースのディレクトリへ進む。
ほとんどのサイトには既定のスペースがすでにあるので、日常では追加しません。2つ目の説明(製品 API など)が必要なときに、新しいスペースを開きます。
スペースを編集する
一覧からそのスペースの設定を開きます(編集ページのタイトルは、スペース設定の編集、という内容です)。
- 既定スペースの slug は変えられません。slug が
defaultの新しいスペースも、自分で作らないでください。 - タイトル、概要、アイコンは変えられます。
- 画面に、このスペースのディレクトリとページへ戻る操作があります。
スペースを削除する
- 既定スペースは削除できません。
- 通常の削除では、先に中のフォルダと記事を空にします。そうしないと、システムは拒否します。
- 中に内容が残り、画面に強制削除が出るとき:確認の欄に
DELETEと入れ、スペースとすべてのノードを消すボタンを押します。ディレクトリごと消えます。元に戻せません。
公開の接頭辞を変える(/docs)
スペース一覧にタイプ設定があるとき(通常はオーナーだけ)、表示名と公開 URL の接頭辞(タイプコード)を変えられます。例:/help。
- 保存すると、すべてのドキュメントの公開 URL が変わります。
- システムは、既存のドキュメント転送の古い接頭辞を、できる範囲で書き換えます。終わったら ドキュメントのリダイレクトを設定する で照合してください。
- 接頭辞は小文字の英字で始め、英数字とアンダースコアだけ。固定のルートや、すでにあるサイトページの slug と重ねないでください。
確認
- スペース一覧にそのスペースがある。
- 開くと空のディレクトリ、または既存のツリーで、ルートのフォルダを追加できる。
- 公開の概要:既定スペースは
/docs。ほかのスペースは/docs/{slug}(接頭辞は実際のもの)。
止まりやすいところ
| 状況 | 対処 |
|---|---|
| スペースを消せない | 先にノードを空にする。または強制削除(すべて消える) |
| slug を変えられない | 既定スペース。想定どおり |
| 接頭辞を変えると古いブックマークが切れる | ドキュメント転送を確認する。大きな変更の前に TimTech と確認する |