Docs: fix parent of WSL.md for the MkDocs sidebar

オープン 初心者向け
#237 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
92/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
markdown, yaml
領域
documentation

調査の方向性

docs/WSL.md を開いてその YAML front matter を確認します。現在は parent: Management Hub が設定されています。これを parent: Installing the management hub only に変更し、docs/docs/hub/hub.md のそのセクション配下にある兄弟ページの nav_order の値を確認して、nav_order: 3 によってこのページが "Getting to know the management hub" の後に配置されることを確かめます。完了とは、ページが意図したサイドバーのセクション内の意図した位置にレンダリングされることです。

索引モデルが issue の本文から書いたものです。

説明

The docs site (open-horizon/open-horizon.github.io) now pulls docs/ from this repository at build time and builds its sidebar from the title / parent / nav_order front matter.

docs/WSL.md has:

title: Windows WSL2 Installation
nav_order: 3
parent: Management Hub

No page has the title Management Hub, so the page cannot be placed and shows at the top level of the sidebar. The section it belongs to is titled Installing the management hub only.

Fix: change the front matter of docs/WSL.md to:

parent: Installing the management hub only

That title is defined in open-horizon.github.io (docs/docs/hub/hub.md). The sibling nav_order values under it are currently 1, 2, 2, 5 and 6, so also confirm that nav_order: 3 puts the page where you want it. The intended position is after "Getting to know the management hub".

Tracking: open-horizon/open-horizon.github.io#729.

主要言語
Shell
スター
12
フォーク
46
平均マージ
5日 12時間
マージ済み PR(30日)
3

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

open-horizon/devops のほかの issue

open-horizon/devops の issue をすべて見る

似ている issue

Shell/Bash の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。