[mkdocs] some examples don't run in the docs
オープン
まだ誰も着手していません。
bug
- 主要言語
- JavaScript
- スター
- 18.3k
- フォーク
- 2k
- 平均マージ
- 2日 12時間
- マージ済み PR(30日)
- 28
説明
If you take an example like this from the current docs, it doesn't run in the mkdocs site
https://plotly.com/javascript/tile-map-layers/#openstreetmap-tiles
This example uses d3 but the mkdocs site isn't loading that.
We should:
- determine what other JS libraries are needed by the docs and ensure the are loaded
and/or - rewrite examples to make sure no additional JS libraries are needed
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
リンクされている JavaScript ドキュメントの OpenStreetMap タイルの例から始め、MkDocs サイトがスクリプトをどのように読み込んでいるかを調べます。外部 JavaScript ライブラリに依存している他のドキュメント例を特定し、それらのライブラリが読み込まれるようにするか、例がそれらを必要としないようにします。完了の条件は、影響を受ける例が MkDocs サイトで実行できることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- d3, javascript
- 領域
- documentation, web-dev
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100