Add mermaid support
メンテナーはふだん 2 日以内に返信
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 静か
- 技術スタック
- python
調査の方向性
まず、Burr に既存する Graphviz および Jupyter 関連の図のサポートを探し、その後、GitHub でレンダリングされる Mermaid markdown とプログラムによる PNG レンダリングがプロジェクトにどう適合するかを比較します。初期実装で npm CLI を必須にするのか、それとも Mermaid markdown の出力だけにするのかを決めます。完了の条件は、依存関係とレンダリング上の制限が明確になった、文書化済みで動作する Mermaid の方法があることです。
索引モデルが issue の本文から書いたものです。
説明
Is your feature request related to a problem? Please describe.
Graphviz requires system dependencies. This could prevent users getting a good experience with Burr.
Describe the solution you'd like
Mermaid diagrams I believe require less to get working.
Thing to figure out:
- you still need something to render the mermaid markdown programmatically if someone wants to create a png.
- github can natively render the mermaid markdown -> so png might not be required (for this initial implementation).
- I believe npm has a CLI that would be installed to work here - and would require someone to install it for things to work..
Describe alternatives you've considered
N/A
Additional context
Feedback from a user.
- 主要言語
- Python
- スター
- 2.6k
- フォーク
- 199
- 平均マージ
- 3日 10時間
- マージ済み PR(30日)
- 6
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
apache/burr のほかの issue
-
status/needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 2 日以内に返信
-
Streaming Event type, type hint, should support union type対応中かも @mvanhorn が 183 日前に担当しました。 オープンarea/streaming area/typing good first issue help wanted kind/bug priority/high
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 2 日以内に返信
-
Add more instructions for applying ORM migrations for S3 deployment対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンarea/storage area/ui help wanted kind/documentation priority/low
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 2 日以内に返信
-
Add documentation on how to run the Burr UI server再び着手できるかも @iamSerafinnn が 122 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンarea/ui good first issue kind/documentation priority/low
難易度 2/5 半日 初心者へのやさしさ 68/100
メンテナーはふだん 2 日以内に返信
-
status/needs-triage
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
メンテナーはふだん 2 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
SR_SECURITY_DESCRIPTOR.fromString drops the SACL when no DACL is present対応中かも @paul7436 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
equinor/fmu-sumo-uploader#302 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
modelscope/evalscope#1821 ·
メンテナーはふだん 1 日以内に返信
-
Sanity on ansible-core devel fails: ignore-2.23.txt references the removed import-3.9 test対応中かも @yurnov が今日担当しました。 オープンneeds_triage
難易度 1/5 1時間未満 初心者へのやさしさ 91/100
ansible-collections/kubernetes.core#1275 ·
メンテナーはふだん 1 日以内に返信