Problems with the TinyMCE plugin docs
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- javascript, php
調査の方向性
moodledev.io/docs/4.2/apis/plugintypes/tiny にある TinyMCE プラグインページを、plugin-options セクションと key-files セクションを含めて確認し、その後 tiny_example レイアウトと lib/editor/tiny/classes/plugin.php のコメントを調べます。例を検索できるようにガイダンスを再構成し、オプションの渡し方と capability チェックを説明し、ボタンとメニュー項目のどちらを選ぶかを明確にし、PHPdoc コメントを改善します。7 件の報告された懸念事項すべてに対応できていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
What is the URL of the page?
https://moodledev.io/docs/4.2/apis/plugintypes/tiny
What is the issue with this page?
Some issues observed while trying (and failing) to make a TinyMCE plugin during the GlobalMoot DevJam.
-
All the useful examples are hidden incollapsbile reasons, so you have to click to see them, and Find-in-page does not work.
-
https://moodledev.io/docs/4.2/apis/plugintypes/tiny#plugin-options---optionsjs-and-plugininfophp spends huge amounts of text explaining how to to pass one string value from PHP to JS - is it really that complicated? Anyway, there is no information about why you might want to do this, when it is appropriate.
-
No-where explains where is the right place to put in a capability check for a feature that should only be available to some users.
-
The page says how to add a button, and how to add a menu item. However, there is no discussion of how to choose which of those you should use.
-
https://moodledev.io/docs/4.2/apis/plugintypes/tiny#key-files - well it starte with common.js, which is hardly key, just a recommended refactoring. Why not, in The directory layout for the
tiny_exampleplugin, and a one-line comment for what each file is. -
I am not sure a tutorial on plguinskel is the thing to put first. It just gets in the way until you know things like whether you want a button or a menu item. I would put that at the end, with a forward-reference.
-
While we are at it, the PHPdoc comments in the code are not great. E.g. the comments on lib/editor/tiny/classes/plugin.php are like a parody of what https://moodledev.io/general/development/abc/comments says you should not to.
Are you able to provide a patch for this?
No (Default)
- 主要言語
- TypeScript
- スター
- 74
- フォーク
- 652
- 平均マージ
- 1日 20時間
- マージ済み PR（30日）
- 10
環境構築
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
moodle/devdocs のほかの issue
-
bug documentation help wanted needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
moodle/devdocs#1673 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
documentation enhancement help wanted needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
bug documentation help wanted needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
bug documentation good first issue needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
moodle/devdocs#1395 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
bug documentation help wanted needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
moodle/devdocs#762 · コメント 5 件 ·
メンテナーはふだん 1 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
microsoft/vscode-livepreview#876 ·
メンテナーはふだん 1 日以内に返信
-
needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
JustJarethB/invoicer#54 ·
-
ICP 1.2.0 shows a scheduled task's interval in milliseconds under the label "Interval (In seconds)"オープンNeeds Triage Type/Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
wso2/product-integrator#2585 ·
メンテナーはふだん 1 日以内に返信
-
check:passed streams:add
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
design
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
MTES-MCT/monitor-field#119 ·
メンテナーはふだん 1 日以内に返信