apache / apache/iotdb

Add the content sidebar of a singe markdown file to the website

オープン
#3,383 コメント 0 件 リアクション 1 件 担当者 0 名 GitHub で見る
主要言語
Java
スター
6.4k
フォーク
1.2k
平均マージ
1日 23時間
マージ済み PR(30日)
115

説明

Now the IoTDB [website](https://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html) has the left sidebar to guide through different markdown files,
but lacks the right sidebar to guide through the different sections in a single markdown file.
It's easy to get lost when reading a long markdown without a content sidebar.
![image](https://user-images.githubusercontent.com/33376433/121475237-ba061d00-c9f7-11eb-8227-34e6dc647af5.png)
![image](https://user-images.githubusercontent.com/33376433/121475750-67793080-c9f8-11eb-8d16-644b3839cd35.png)

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

ソースファイル、テスト、エントリーポイントのいずれも指定されていません。まず、リンクされた IoTDB ウェブサイトを調べ、Markdown ページがどのように生成されているかを特定してください。セクション見出しがどのように表現されているかを確認してください。長い単一ページの Markdown ドキュメントに、各セクションへのリンクを含む右側のコンテンツサイドバーが表示されれば完了です。

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

評価

技術スタック
markdown
領域
documentation, web-dev
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
30/100

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

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