IBX-5222: Work with drafts #298
Conversation
docs/content_management/workflow_management/work_with_versions.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Justyna Koralewicz <[email protected]>
docs/content_management/workflow_management/work_with_versions.md
Outdated
Show resolved
Hide resolved
|
|
“Describe mechanism of creating new drafts in draft conflict state” - wasn’t this the scope of the PR? |
There was a problem hiding this comment.
General comment: PR is a bit unclear and hard to review, as it contains two separate topics:
- Describe mechanism of creating new drafts in draft conflict state - scope of this PR
and - Reorganization and corrections of the remaining part - out of scope.
1 PR = 1 scope. I'd suggest to keep "Draft conflicts" part only in this PR.
| You then see a [**Draft conflict**](content_versions.md#draft-conflicts) screen, where you can pick a draft for editing, or create a new one. | ||
| The new draft is based on the published version of the content item and does not contain changes from other drafts. | ||
|
|
||
|  |
There was a problem hiding this comment.
I would move this to "Draft conflicts" section.
In my opinion, we shouldn't describe conflicts in another sections, like "Edit", because this shouldn't be treated as "normal" behaviour / good practice.
|  | ||
| #### Draft conflicts | ||
|
|
||
| If several drafts exist of the same content item, for example, created by different users or as a result of different processes, they can contain conflicting changes. |
There was a problem hiding this comment.
I'd rewrite it. As an opening sentence it should be shorter and really clear.
"Conflicting changes" - maybe you could rewrite it and use something like "can cause conflicts", etc?
| #### Draft conflicts | ||
|
|
||
| If several drafts exist of the same content item, for example, created by different users or as a result of different processes, they can contain conflicting changes. | ||
| Such draft conflicts can be resolved by using the [Version Compare](work_with_versions.md#compare-versions) feature. |
There was a problem hiding this comment.
"Version compare" - capital "C" not needed, this is what you can see when you hover over an icon:
Also, I'm not sure about calling it "Version compare" feature. It'd be more understandable if you say "you can compare versions".
| ## Compare versions | ||
| You can compare two versions of the same content item. | ||
| ## Compare versions | ||
| You can compare two versions of the same content item, for example, to resolve a conflict between drafts coming from different sources. |
There was a problem hiding this comment.
Same as above: I'd not add sentence about conflicts here.
In "Draft conflicts" section you can highlight comparison, it's enough.
|
|
||
|  | ||
| #### Draft conflicts |
There was a problem hiding this comment.
I'm missing here some more explanation, as @juskora mentioned in her comment.
You could show here how to resolve such conflict, etc.
Describe mechanism of creating new drafts in draft conflict state
Preview
https://ez-systems-developer-documentation--298.com.readthedocs.build/projects/userguide/en/298/content_management/content_versions/#drafts
Checklist