Drafts / Revision creation, Saving, and Conflict Resolution unclear / unexplained for Front End Authors
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
調査の方向性
リンクされている「Editing Entries in Craft 3.7」の記事と関連する issue #36 から始め、その後、issue に記載されている下書きと改訂のワークフローを確認してください。青いバー、最近の変更との比較、マージと上書きの動作、Matrix の並べ替え、ブロックの同時作成について文書化します。これらのケースについて著者が参照できる正式なガイダンスを得られれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Description
This is a front end author corollary to #36, the drafts / revisions workflow needs more documentation.
Editing Entries in Craft 3.7 is good basic introduction—however, as site size and entry complexity grow there are things it doesn't cover and I can't find canonical documentation for to point authors to for how it is all supposed to work. (Clarity on how it is supposed to work also makes it easier to know when something is a bug report versus a feature request.)
The big thing that is missing is edit conflict resolution and when you might accidentally overwrite someone else's changes without noticing. The automatic persistence of unsaved edits across page loads is very helpful, but it does mean that, in effect, people can be editing an entry "at the same time" hours, days, or even months apart.
Key concepts I noticed that need to be better explained:
- How to use the blue bar to keep track of what will be updated on save.
- How to compare your version to the current version when the "recent changes" warning appears.
- When merging a draft with the current version what get's merged and what get's overwritten.
- How Matrix reordering happens when merging a draft.
- What happens on the creation of different matrix blocks on two different drafts?
Additional info
- Craft version: 4.2.7
- PHP version: 8.1
- Database driver & version: MySQL 5.5.5
- 主要言語
- JavaScript
- スター
- 43
- フォーク
- 160
- 平均マージ
- 3時間 57分
- マージ済み PR（30日）
- 3
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
craftcms/docs のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
Broken Link対応中かも @PerceiveWorld が 141 日前に担当しました。 オープンBroken Link
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 1/5 1〜3時間 初心者へのやさしさ 68/100
-
Broken LinkオープンBroken Link
難易度 1/5 1時間未満 初心者へのやさしさ 68/100
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
druxt/umami.demo.druxtjs.org#527 ·
メンテナーはふだん 9 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
NuSkooler/enigma-bbs#907 ·
メンテナーはふだん 1 日以内に返信
-
documentation good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
documentation good first issue help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
メンテナーはふだん 1 日以内に返信