Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IBX-5222: Work with drafts #298

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 30 additions & 16 deletions docs/content_management/content_versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,45 @@
In [[= product_name =]], content items can have more than one version.
Versions can be of published, archived, or draft type.

The **published version** is the version that is currently presented to the audience.
You can view all versions of a content item on the content item details screen.
To do it, [disable the Focus mode](../getting_started/discover_ui.md#disable-focus-mode), and go to this content item's **Versions** tab.

![All versions of a content item](img/content_item_versions.png "All versions of a content item")

### Published version

Published version is the version that is currently presented to the visitors.
Every content item can have only one published version at a time.

Whenever you edit and publish a content item again, its previous published version becomes an **archived version**.
It is not available to the visitor and you cannot edit it, but you can create new drafts based on any archived version.
### Archived versions

Finally, **drafts** are versions that have not been published yet.
Whenever you edit and publish a content item again, its previous published version becomes an archived version.
It is not available to the visitors and you cannot edit it, but you can create new drafts based on any archived version.

### Drafts

Drafts are versions that have not been published yet.
There can be many drafts of the same content item.
They can be created by the autosave feature, by the reviewer as part of the
[editorial workflow](workflow_management/editorial_workflow.md), or when you save
the work and close the content item editing screen.
Drafts can be created in many ways, including:

You can view all versions of a content item on the content item details screen.
To do it, [disable the Focus mode](../getting_started/discover_ui.md#disable-focus-mode), and go to this content item's **Versions** tab.
- by the [autosave](#autosave) feature
- by reviewers, as part of the [editorial workflow](workflow_management/editorial_workflow.md)
- by editors, when they save a content item while editing it or close a content item's editing screen after making changes, but without publishing them

![All versions of a content item](img/content_item_versions.png "All versions of a content item")
#### Draft conflicts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm missing here some more explanation, as @juskora mentioned in her comment.
You could show here how to resolve such conflict, etc.


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.

Check warning on line 39 in docs/content_management/content_versions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/content_versions.md#L39

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/content_management/content_versions.md", "range": {"start": {"line": 39, "column": 1}}}, "severity": "WARNING"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Such draft conflicts can be resolved by using the [Version Compare](work_with_versions.md#compare-versions) feature.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Version compare" - capital "C" not needed, this is what you can see when you hover over an icon:
version compare

Also, I'm not sure about calling it "Version compare" feature. It'd be more understandable if you say "you can compare versions".


For more information, see [Editorial workflow](workflow_management/editorial_workflow.md) and [Work with versions](work_with_versions.md).
For more information about various operations on content versions, see [Work with versions](work_with_versions.md).

### Autosave
## Autosave

While you edit a content item or product, [[= product_name =]] saves your work automatically to help you preserve the progress in an event of a failure.
While you edit a content item or product, [[= product_name =]] automatically saves your work as a new draft to help you preserve the progress in case of a failure.
To recover your work, [disable the Focus mode](../getting_started/discover_ui.md#disable-focus-mode), go to this content item's **Versions** tab, and open the most recent draft.
Alternatively, open the most recent draft of your work on the **My dashboard** page, the **Drafts** table.
Alternatively, open the most recent draft of your work on the **Dashboard** page, **My content** area.

Check warning on line 48 in docs/content_management/content_versions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/content_versions.md#L48

[Ibexa.DontCapitalize] Don't capitalize 'Dashboard' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Dashboard' if inside the sentence.", "location": {"path": "docs/content_management/content_versions.md", "range": {"start": {"line": 48, "column": 65}}}, "severity": "WARNING"}

Autosave is enabled by default, and set to save a draft every 60 seconds.
You can toggle autosave or change the time between saving attempts in **User settings**, by changing
the values in the **Autosave draft** and **Autosave interval** fields.
You can toggle autosave and/or change the time between saving attempts.
To do this, in the upper-right corner of the screen, click your avatar icon, and then click **User settings**, **Preferences**.
In the **Content authoring** section, change the values of the **Autosave draft every given period** and **Seconds till next draft autosave** fields.
Binary file added docs/content_management/img/draft_conflict.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/content_management/publish_instantly.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ All these options are available in the menu when you are in the edit mode.
### Publishing vs. saving

Clicking **Save** does not immediately publish the content item.
Instead, it saves the [new version](content_versions.md) of the content as a draft.
Instead, it saves the [new version](content_versions.md) of the content as a [draft](content_versions.md/#drafts).
You can then keep on editing the same content and save it again when needed,
or click **Save and close** to close the window.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 26 additions & 20 deletions docs/content_management/workflow_management/work_with_versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,48 @@

In [[= product_name =]], content items can have one published [version](../content_versions.md),
and several draft and archived versions.
You can perform various tasks on content item versions, either to advance them
through the workflow or compare edits from different users.

You can perform various tasks on content item versions, either to advance them through the workflow or compare edits from different users.

## Edit drafts

If you are assigned to a draft version of a content item for [review](editorial_workflow.md),
when you click the **Edit draft** icon in **My dashboard**, the **Review queue**
table, you see the **Event(s)** timeline that lists all the transitions that this
content has gone through.
There are several ways in which you can start editing an existing draft:

Check warning on line 13 in docs/content_management/workflow_management/work_with_versions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/workflow_management/work_with_versions.md#L13

[Ibexa.UnclearAntecedent] Instead of 'There are', try starting this sentence with a specific subject and verb.
Raw output
{"message": "[Ibexa.UnclearAntecedent] Instead of 'There are', try starting this sentence with a specific subject and verb.", "location": {"path": "docs/content_management/workflow_management/work_with_versions.md", "range": {"start": {"line": 13, "column": 1}}}, "severity": "WARNING"}

- by picking a draft for editing from the content item's details screen, **Versions** tab, the **Open drafts** list.
You may need to [disable the Focus mode](../../getting_started/discover_ui.md#disable-focus-mode) first.

Check warning on line 16 in docs/content_management/workflow_management/work_with_versions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/workflow_management/work_with_versions.md#L16

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/content_management/workflow_management/work_with_versions.md", "range": {"start": {"line": 16, "column": 105}}}, "severity": "WARNING"}

![Open drafts list](img/open_drafts.png "Open drafts list")

- by editing a content item that already has open drafts.
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.
dabrt marked this conversation as resolved.
Show resolved Hide resolved
dabrt marked this conversation as resolved.
Show resolved Hide resolved
The new draft is based on the published version of the content item and does not contain changes from other drafts.

![Draft conflict](img/draft_conflict.png "Draft conflict")
Comment on lines +21 to +24
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


- when you are assigned to a draft version of the content item for [review](editorial_workflow.md), by picking a draft for editing from the [Dashboard](discover_ui.md#dashboard), **Review queue**

![Review queue](img/workflow_review_queue.png "Review queue")

When you review a content item, you see the **Event(s)** timeline that lists all the transitions that this content has gone through.

Check warning on line 30 in docs/content_management/workflow_management/work_with_versions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/workflow_management/work_with_versions.md#L30

[Ibexa.DontCapitalize] Don't capitalize 'Event' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Event' if inside the sentence.", "location": {"path": "docs/content_management/workflow_management/work_with_versions.md", "range": {"start": {"line": 30, "column": 47}}}, "severity": "WARNING"}

![Events timeline](img/workflow_events_timeline.png)

If draft locking is supported, you also see a message that confirms that the draft is now locked to you.

![Draft assignment message](img/lock_message.png)

## Release locked drafts
### Release locked drafts

If you are assigned to a draft version of a content item and have locked it for
review, you can release the lock by closing the modal window, publishing the draft,
or sending it to another reviewer.
You can also do it in **My dashboard**, the **Review queue** table, by clicking
the **Unlock** icon.
If you are assigned to a draft version of a content item and have locked it for review, you can release the lock by closing the modal window, publishing the draft, or sending it to another reviewer.
You can also do it in the **Dashboard**, the **Review queue** table, by clicking the **Unlock** icon.

Check warning on line 41 in docs/content_management/workflow_management/work_with_versions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/workflow_management/work_with_versions.md#L41

[Ibexa.DontCapitalize] Don't capitalize 'Dashboard' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Dashboard' if inside the sentence.", "location": {"path": "docs/content_management/workflow_management/work_with_versions.md", "range": {"start": {"line": 41, "column": 29}}}, "severity": "WARNING"}

If you are not assigned to the draft, depending on the permissions set for your
Role, in the **Review queue** table, you can either release the lock by clicking
the **Unlock** icon, or request that the lock is released by the reviewer
by clicking the **Request access** icon.
If you are not assigned to the draft, depending on the permissions set for your Role, in the **Review queue** table, you can either release the lock by clicking the **Unlock** icon, or request that the lock is released by the reviewer by clicking the **Request access** icon.

## 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above: I'd not add sentence about conflicts here.
In "Draft conflicts" section you can highlight comparison, it's enough.


To do it, [disable the Focus mode](../../getting_started/discover_ui.md#disable-focus-mode).
Then, in the content item details screen, go to the **Versions** tab and click the
**Version Compare** icon: ![Version Compare Icon](img/version_compare_icon.png){.inline-image}.
**Version Compare** icon: ![Version Compare icon](img/version_compare_icon.png){.inline-image}.

Check warning on line 50 in docs/content_management/workflow_management/work_with_versions.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/content_management/workflow_management/work_with_versions.md#L50

[Ibexa.DontCapitalize] Don't capitalize 'Version' if inside the sentence.
Raw output
{"message": "[Ibexa.DontCapitalize] Don't capitalize 'Version' if inside the sentence.", "location": {"path": "docs/content_management/workflow_management/work_with_versions.md", "range": {"start": {"line": 50, "column": 3}}}, "severity": "WARNING"}

From the drop-down menus at the top of the screen, select the two versions that you want to compare.

Expand Down
Loading