diff --git a/docs/editor_manual/administrator_tasks/managing_workflows.rst b/docs/editor_manual/administrator_tasks/managing_workflows.rst index 32e1a59070..adb7dd3901 100644 --- a/docs/editor_manual/administrator_tasks/managing_workflows.rst +++ b/docs/editor_manual/administrator_tasks/managing_workflows.rst @@ -11,7 +11,8 @@ The workflow management interface is accessed via the `Workflows` item in the `S .. image:: ../../_static/images/screen45_workflow_index.png In this interface you can see all of the workflows on your site, and the order of tasks in each. You can click on a workflow to edit it or to assign it -to part of the page tree, or use the `Add a workflow` button to create a new workflow. +to part of the page tree, or use the `Add a workflow` button to create a new workflow. The number of pages each workflow applies to is also shown, and can be +clicked for a complete listing. Editing workflows @@ -20,12 +21,14 @@ _________________ .. image:: ../../_static/images/screen44_workflow_edit.png -Under `Tasks`, you can add, remove, or reorder tasks in a workflow. You may also disable the workflow, which will cancel all pages currently -in moderation on this workflow, and prevent others from starting it. +Under `Tasks`, you can add, remove, or reorder tasks in a workflow. When adding a task to a workflow, you will be given the +option to create a new task, or reuse an existing one. Under `Pages`, you can see a list of the pages to which the workflow has been assigned: any child pages will also have the same workflow, -so if a workflow is assigned to the root page, it becomes the default workflow. You may remove it from pages using the `Remove` button to -the right of each entry, or assign it to a page using the `Add to page` button. +so if a workflow is assigned to the root page, it becomes the default workflow. You may remove it from pages using the `Delete` button to +the right of each entry, or assign it to a page using the `Choose a page` button. + +The action menu at the bottom allows you to save your changes, or to disable the workflow, which will cancel all pages currently in moderation on this workflow, and prevent others from starting it. Creating and editing tasks @@ -33,8 +36,8 @@ __________________________ .. image:: ../../_static/images/screen46_task_index.png -In the tasks interface, accessible via the `Tasks` button in the upper right corner of the workflow management interface, you can see a list of the tasks -currently available. Similarly to workflows, you can click an existing task to edit it, or the `Add a task` button to create a new task. +In the tasks interface, accessible via the `Workflow Tasks` item in the `Settings` submenu, you can see a list of the tasks +currently available, as well as which workflows use each task. Similarly to workflows, you can click an existing task to edit it, or the `Add a task` button to create a new task. When creating a task, if you have multiple task types available, these will be offered as options. By default, only `group approval tasks` are available. Creating a `group approval task`, you will be able to select one or multiple groups: members of any of these, as well as administrators, will be able to @@ -42,6 +45,6 @@ approve or reject moderation for this task. .. image:: ../../_static/images/screen47_task_create.png -When editing a task, you may find that some fields - including the groups in a `group approval task` are uneditable. This is to ensure workflow history -remains consistent - if you find yourself needing to change the group, it is recommended that you disable the old task, and create a new one with the groups +When editing a task, you may find that some fields - including the name - are uneditable. This is to ensure workflow history +remains consistent - if you find yourself needing to change the name, it is recommended that you disable the old task, and create a new one with the name you need. Disabling a task will cause any pages currently in moderation on that task to skip to the next task. \ No newline at end of file diff --git a/docs/editor_manual/editing_existing_pages.rst b/docs/editor_manual/editing_existing_pages.rst index 47f403f2df..b3e248838b 100644 --- a/docs/editor_manual/editing_existing_pages.rst +++ b/docs/editor_manual/editing_existing_pages.rst @@ -10,19 +10,20 @@ Here is how you can access the edit screen of an existing page: .. image:: ../_static/images/screen12_edit_screen_overview.png * When editing an existing page the title of the page being edited is displayed at the top of the page. -* The current status of the page is displayed in the top-right. +* Underneath the title, you can find the page type and a link to the page history. +* If published, a link to the live version of the page is shown on the top right. * You can change the title of the page by clicking into the title field. * When you are typing into a field, help text is often displayed on the right-hand side of the screen. -Moderation -__________ +Workflow +_________ -If the page is currently in moderation, you'll see a banner at the top of the screen. If the moderation workflow for the current page has more than -one step, it will tell you which step the page is on. You'll also see an indicator to the right of the page title, showing the name of the moderation workflow, -and a set of icons representing completed and incomplete tasks. The name can be clicked to show more information about the current workflow's progress. +If the page is currently in workflow, you'll see an additional indicator underneath the title, giving the current workflow task. Clicking this will +show more information about the page's progress through the workflow, as well as any comments left by reviewers. .. image:: ../_static/images/screen12.5_edit_screen_in_moderation.png -If you can perform moderation actions (for example, approval or rejection) on the current task, you'll see an additional menu at the bottom of the page -to the right of the action menu, providing these options. +If you can perform moderation actions (for example, approval or requesting changes) on the current task, you'll see additional options in the +action menu at the bottom of the page. + diff --git a/docs/editor_manual/finding_your_way_around/the_dashboard.rst b/docs/editor_manual/finding_your_way_around/the_dashboard.rst index 8c7640ea8b..0fdd754970 100644 --- a/docs/editor_manual/finding_your_way_around/the_dashboard.rst +++ b/docs/editor_manual/finding_your_way_around/the_dashboard.rst @@ -17,23 +17,23 @@ You can return to the Dashboard at any time by clicking the Wagtail logo in the - Clicking the logo returns you to your Dashboard. - The stats at the top of the page describe the total amount of content on the CMS (just for fun!). -- The *Your pages in workflow moderation* table shows you any pages in moderation that you own or submitted for moderation yourself, along with which - moderation tasks they are currently on. +- The *Your pages in a workflow* panel shows you any pages in moderation that you own or submitted for moderation yourself, along with which + moderation tasks they are awaiting, and how long they've been on that task. -- The *Pages you can moderate* table will only be displayed if you are able to perform moderation actions. +- The *Awaiting your review* table will only be displayed if you are able to perform moderation actions. - Clicking the name of a page will take you to the ‘Edit page’ interface for this page. - - Clicking approve or reject will either progress the page to the next task in the moderation workflow (or publish if it's the final stage) or return the page to draft status. An email will be sent to the creator of the page giving the result of the overall workflow when it completes. - - The *Task* column shows which moderation task the page is currently in, and the *Task started* column when the current task was started + - Clicking approve or request changes will either progress the page to the next task in the moderation workflow (or publish if it's the final stage) or mark the page as needing changes and return it to normal editing. An email will be sent to the creator of the page giving the result of the overall workflow when it completes. + - The status indicator circles show the progress through the workflow: a tick for a completed task, or an empty circle for an incomplete one. Tooltips provide more details on the status of each. + - The time this page has been waiting for review on this task is also shown to the right. -- The *Your locked pages* table shows the pages you've locked so that only you can edit them. -- The *Locked At* column displays the date you locked the page. +- The *Your locked pages* panel shows the pages you've locked so that only you can edit them. +- The date you locked the page is displayed to the right. - Clicking the name of a page will take you to the ‘Edit page’ interface for this page. -- Clicking *See all locked pages* will take you to the *Locked Pages* Report, showing the pages locked by any user - The *Your most recent edits* table displays the five pages that you most recently edited. -- The date column displays the date that you edited the page. Hover your mouse over the date for a more exact time/date. -- The status column displays the current status of the page. A page will have one of three statuses: +- The date that you edited the page is displayed. Hover your mouse over the date for a more exact time/date. +- The current status of the page is displayed. A page will have one of three statuses: - Live: Published and accessible to website visitors - Draft: Not live on the website.