Drafts / Revision creation, Saving, and Conflict Resolution unclear / unexplained for Front End Authors
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with the linked “Editing Entries in Craft 3.7” article and related issue #36, then review the drafts and revisions workflow described in the issue. Document the blue bar, recent-changes comparison, merge and overwrite behavior, Matrix reordering, and concurrent block creation; done means authors have canonical guidance for these cases.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- JavaScript
- Stars
- 42
- Forks
- 160
- Avg merge
- 3h 9m
- Merged PRs (30d)
- 4
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from craftcms/docs
-
Broken Link OpenBroken Link
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 68/100
-
Broken Link OpenBroken Link
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
[Broken Link]: Open
Difficulty 1/5 Under an hour Newbie friendliness 65/100
Similar issues
-
area/install-update comp/cli comp/desktop P3 sweeper:risk-compatibility type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
NousResearch/hermes-agent#122386 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
security
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
IBM/node-sdk-core#373 ·
-
docs web/
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100