VPR: growing list of gsubs creates risk
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 30/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- ruby
- 領域
- documentation, tooling
調査の方向性
versioned_plugins.rb の312〜330行付近を読んで現在のグローバルな gsub 置換を理解し、その後、意図しない副作用について issue #59 を確認してください。置換を特定のプラグインまたはバージョンに限定する方法を定義し、設定ベースの指定を求める要望を検討してください。修正によって無関係なプラグインやリリース済みバージョンに影響が及ばなくなれば完了です。
索引モデルが issue の本文から書いたものです。
説明
In the versioned plugin reference (VPR) we generate docs for every version of every plugin, but unfortunately some plugins have broken docs in certain released versions that if left unfixed would break our docs build. We cannot modify the source of released plugins, so to address this we have a growing list of gsub expressions that are applied to find the offending substring and replace it with something valid.
These gsub replacements are applied to all plugins, and can end up with unintended side-effects (like the helpful replacement of [source] with [source,shell] for improved syntax highlighting also mucking up ECS docs referencing the [source] field [#59]).
It would be nice to be able to constrain a fix to a particular plugin, or even to specific versions of a plugin. Bonus points for being able to specify in config instead of in code.
- 主要言語
- Ruby
- スター
- 4
- フォーク
- 12
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
elastic/docs-tools のほかの issue
-
LSR
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
elastic/docs-tools#110 · コメント 5 件 ·
-
VPR
難易度 4/5 3〜5日 初心者へのやさしさ 42/100
elastic/docs-tools#109 · コメント 1 件 ·
-
Missing plugin VPR docs between placeholder generation and last commit date.再び着手できるかも @mashhurs が 1117 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
elastic/docs-tools#100 · コメント 2 件 · 担当者 1 名 ·
-
VPR: Revisit allowing a non-standard landing page (use case: new integrations)再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープンVPR
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
elastic/docs-tools#89 · コメント 1 件 ·
-
VPR
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
elastic/docs-tools#88 ·
elastic/docs-tools の issue をすべて見る
似ている issue
-
area/web interface
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
rubys/roundhouse#1757 ·
-
難易度 2/5 半日 初心者へのやさしさ 72/100
shakacode/react-on-rails-demo-flagship#102 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
akitaonrails/ai-book-2026#12 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
openfoodfoundation/openfoodnetwork#14970 ·
メンテナーはふだん 1 日以内に返信