diff --git a/source/_static/images/page/page-workflows-request-publish-later.webp b/source/_static/images/page/page-workflows-request-publish-later.webp index 78a475c16..07fc5f436 100644 Binary files a/source/_static/images/page/page-workflows-request-publish-later.webp and b/source/_static/images/page/page-workflows-request-publish-later.webp differ diff --git a/source/_static/images/page/page-workflows-request-publish.webp b/source/_static/images/page/page-workflows-request-publish.webp index dfe1e12c6..83bc18c9e 100644 Binary files a/source/_static/images/page/page-workflows-request-publish.webp and b/source/_static/images/page/page-workflows-request-publish.webp differ diff --git a/source/_static/images/page/page-workflows-submitted-view-packages-option.webp b/source/_static/images/page/page-workflows-submitted-view-packages-option.webp new file mode 100644 index 000000000..6e706e83f Binary files /dev/null and b/source/_static/images/page/page-workflows-submitted-view-packages-option.webp differ diff --git a/source/_static/images/page/page-workflows-view-packages-dialog.webp b/source/_static/images/page/page-workflows-view-packages-dialog.webp new file mode 100644 index 000000000..cf8debbf2 Binary files /dev/null and b/source/_static/images/page/page-workflows-view-packages-dialog.webp differ diff --git a/source/_static/images/page/page-workflows.webp b/source/_static/images/page/page-workflows.webp index 3efec8d86..21e4e309f 100644 Binary files a/source/_static/images/page/page-workflows.webp and b/source/_static/images/page/page-workflows.webp differ diff --git a/source/_static/images/site-admin/project-config-select-state-dialog.webp b/source/_static/images/site-admin/project-config-select-state-dialog.webp index 94c3b7a17..a59b57ca8 100644 Binary files a/source/_static/images/site-admin/project-config-select-state-dialog.webp and b/source/_static/images/site-admin/project-config-select-state-dialog.webp differ diff --git a/source/_static/images/site-admin/project-tools-publish-bulk.webp b/source/_static/images/site-admin/project-tools-publish-bulk.webp index 3475e9f2d..b47e9b569 100644 Binary files a/source/_static/images/site-admin/project-tools-publish-bulk.webp and b/source/_static/images/site-admin/project-tools-publish-bulk.webp differ diff --git a/source/_static/images/site-admin/project-tools-publish-commit-id.webp b/source/_static/images/site-admin/project-tools-publish-commit-id.webp index 1bb1f3552..4faf9b73d 100644 Binary files a/source/_static/images/site-admin/project-tools-publish-commit-id.webp and b/source/_static/images/site-admin/project-tools-publish-commit-id.webp differ diff --git a/source/_static/images/site-admin/project-tools-publish-on-demand-initial-detail.webp b/source/_static/images/site-admin/project-tools-publish-on-demand-initial-detail.webp new file mode 100644 index 000000000..dd2f17cb2 Binary files /dev/null and b/source/_static/images/site-admin/project-tools-publish-on-demand-initial-detail.webp differ diff --git a/source/_static/images/site-admin/project-tools-publish-on-demand-initial.webp b/source/_static/images/site-admin/project-tools-publish-on-demand-initial.webp index e6c645b02..3f6f34a44 100644 Binary files a/source/_static/images/site-admin/project-tools-publish-on-demand-initial.webp and b/source/_static/images/site-admin/project-tools-publish-on-demand-initial.webp differ diff --git a/source/_static/images/site-admin/project-tools-publish-path.webp b/source/_static/images/site-admin/project-tools-publish-path.webp index 5a8de4a91..5bb4ad4f6 100644 Binary files a/source/_static/images/site-admin/project-tools-publish-path.webp and b/source/_static/images/site-admin/project-tools-publish-path.webp differ diff --git a/source/_static/images/site-admin/project-tools-publish-queue-filter-cancel.webp b/source/_static/images/site-admin/project-tools-publish-queue-filter-cancel.webp index 90c17ea0b..0d560a927 100644 Binary files a/source/_static/images/site-admin/project-tools-publish-queue-filter-cancel.webp and b/source/_static/images/site-admin/project-tools-publish-queue-filter-cancel.webp differ diff --git a/source/_static/images/site-admin/project-tools-publish-queue-filter-completed.webp b/source/_static/images/site-admin/project-tools-publish-queue-filter-completed.webp index cd3031d65..22164794a 100644 Binary files a/source/_static/images/site-admin/project-tools-publish-queue-filter-completed.webp and b/source/_static/images/site-admin/project-tools-publish-queue-filter-completed.webp differ diff --git a/source/_static/images/site-admin/project-tools-publish-queue-filter.webp b/source/_static/images/site-admin/project-tools-publish-queue-filter.webp index f69498ae4..c31226b31 100644 Binary files a/source/_static/images/site-admin/project-tools-publish-queue-filter.webp and b/source/_static/images/site-admin/project-tools-publish-queue-filter.webp differ diff --git a/source/_static/images/site-admin/project-tools-publish-queue.webp b/source/_static/images/site-admin/project-tools-publish-queue.webp index 9f80d8760..5d927e2b5 100644 Binary files a/source/_static/images/site-admin/project-tools-publish-queue.webp and b/source/_static/images/site-admin/project-tools-publish-queue.webp differ diff --git a/source/_static/images/site-admin/project-tools-publishing-package.webp b/source/_static/images/site-admin/project-tools-publishing-package.webp index a6301e107..406ec470a 100644 Binary files a/source/_static/images/site-admin/project-tools-publishing-package.webp and b/source/_static/images/site-admin/project-tools-publishing-package.webp differ diff --git a/source/_static/images/site-admin/project-tools-unlock-publish-confirm.webp b/source/_static/images/site-admin/project-tools-unlock-publish-confirm.webp deleted file mode 100644 index 4dac6d252..000000000 Binary files a/source/_static/images/site-admin/project-tools-unlock-publish-confirm.webp and /dev/null differ diff --git a/source/_static/images/site-admin/project-tools-unlock-publish.webp b/source/_static/images/site-admin/project-tools-unlock-publish.webp deleted file mode 100644 index 3f2151f35..000000000 Binary files a/source/_static/images/site-admin/project-tools-unlock-publish.webp and /dev/null differ diff --git a/source/_static/images/site-admin/project-tools-workflow-states.webp b/source/_static/images/site-admin/project-tools-workflow-states.webp index 4606463d4..48866f3a6 100644 Binary files a/source/_static/images/site-admin/project-tools-workflow-states.webp and b/source/_static/images/site-admin/project-tools-workflow-states.webp differ diff --git a/source/_static/images/system-admin/staging-publish-option.webp b/source/_static/images/system-admin/staging-publish-option.webp index 7aa641c90..dcca596da 100644 Binary files a/source/_static/images/system-admin/staging-publish-option.webp and b/source/_static/images/system-admin/staging-publish-option.webp differ diff --git a/source/by-role/author/index.rst b/source/by-role/author/index.rst index 4f34a927e..4ecee48f0 100644 --- a/source/by-role/author/index.rst +++ b/source/by-role/author/index.rst @@ -2055,14 +2055,14 @@ When sending the request for publish, you have the option of requesting to publi or to schedule publishing of your content at a later time and date. .. image:: /_static/images/page/page-workflows.webp - :width: 65 % + :width: 85 % :align: center :alt: Workflow - Request publish now dialog | .. image:: /_static/images/page/page-workflows-request-publish-later.webp - :width: 65 % + :width: 85 % :align: center :alt: Workflow - Request publish later dialog @@ -2072,7 +2072,7 @@ Users with permission to publish can also make changes and request approval for by checking the ``Request approval`` checkbox in the Publish dialog .. image:: /_static/images/page/page-workflows-request-publish.webp - :width: 65 % + :width: 85 % :align: center :alt: Workflow - Request publish approval dialog @@ -2086,7 +2086,7 @@ now or later), a notification email will be sent to the project's approvers. Not toolbar now displays the icon for **Submitted** .. image:: /_static/images/page/page-workflows-submitted-context-nav.webp - :width: 75 % + :width: 95 % :align: center :alt: Workflow - Request publish submitted context nav updated icon and text @@ -2096,12 +2096,31 @@ You'll also notice the **Submitted** icon is displayed next to the content item content you just submitted a request for publish and contains the text **Submitted for live** .. image:: /_static/images/page/page-workflows-submitted-nav-tree.webp - :width: 25 % + :width: 35 % :align: center :alt: Workflow - Request publish submitted Sidebar nav tree content updated icon | +When clicking on **Options** (three dots) for the submitted items, the option to ``View Packages``, which +allows you to view the packages where the current item is included, is now available: + +.. image:: /_static/images/page/page-workflows-submitted-view-packages-option.webp + :width: 65 % + :align: center + :alt: Workflow - **View Packages** option now available + +| + +Here's the ``View Packages`` dialog: + +.. image:: /_static/images/page/page-workflows-view-packages-dialog.webp + :width: 75 % + :align: center + :alt: Workflow - **View Packages** option now available + +| + The **Submitted** icon also appears next to the content submitted for publish in the dashboard: .. image:: /_static/images/page/page-workflows-submitted-dashboard.webp diff --git a/source/by-role/common/project-tools/publishing-and-status.rst b/source/by-role/common/project-tools/publishing-and-status.rst index 48f9099a4..3c6190dc7 100644 --- a/source/by-role/common/project-tools/publishing-and-status.rst +++ b/source/by-role/common/project-tools/publishing-and-status.rst @@ -1,5 +1,5 @@ :is-up-to-date: True -:last-updated: 4.1.1 +:last-updated: 5.0.0 .. index:: Publishing Status, Bulk Publish, Publish by Commit Id @@ -8,7 +8,7 @@ ================= Publishing Status ================= -The **Publishing** tool under |projectTools| allows the user to view the publishing status, +The **Publishing** tool under ``Project Tools`` allows the user to view the publishing status, publish multiple items from a specified path, publish commits from sandbox repository by commit id or tag and view the publishing queue. @@ -21,7 +21,6 @@ The **Status** section allows the user to view the publishing status, such as th - The publisher was stopped by an administrator. - The publisher was stopped due to an error. -- Preparing items for publishing. {numberOfItems} out of {totalItems} processed so far. It also allows the user to **Start** or **Stop** Studio publishing @@ -31,23 +30,6 @@ It also allows the user to **Start** or **Stop** Studio publishing | -Publishing is locked when content is being published. From the Status tab, you can unlock publishing by clicking on the ``unlock`` button that is displayed during content publishing. - -.. image:: /_static/images/site-admin/project-tools-unlock-publish.webp - :alt: Project Tools Publishing - Unlock icon - :align: center - -| - -After clicking on the ``unlock`` button, the user will be prompted to confirm the action: - -.. image:: /_static/images/site-admin/project-tools-unlock-publish-confirm.webp - :alt: Project Tools Publishing - Unlock icon - :width: 35% - :align: center - -| - |hr| ----------------- @@ -67,7 +49,12 @@ The user will first be asked to publish the entire project, if the project has n .. image:: /_static/images/site-admin/project-tools-publish-on-demand-initial.webp :alt: Project Tools Publishing - Initial Publish :align: center - :width: 75% + +| + +.. image:: /_static/images/site-admin/project-tools-publish-on-demand-initial-detail.webp + :alt: Project Tools Publishing - Initial Publish details + :align: center | @@ -76,9 +63,9 @@ Publish by path ^^^^^^^^^^^^^^^ The **Publish changes made in Studio via the UI** selection allows the user to publish multiple items under a specified path. This should be used to publish changes made in Studio via the UI. -For example, using the Website Editorial blueprint, to publish all the articles in the year 2021, in the **Path to Publish** field, enter ``/site/website/articles/2021``. To publish everything in your project, the user will enter ``/`` in the **Path to Publish** field +For example, using the Website Editorial blueprint, to publish all the articles in the year 2021, in the **Path to Publish** field, enter ``/site/website/articles/2021``. Fill in the ``Package Title`` and ``Submission Comment`` and choose the ``Publishing Target``, then click on the ``Publish`` button. -.. image:: /_static/images/site-admin/project-tools-publish-bulk.webp +.. image:: /_static/images/site-admin/project-tools-publish-path.webp :alt: Project Tools Publishing - Publish changes made in Studio via the UI :align: center @@ -127,10 +114,10 @@ To publish by commit id, let's use a project created using the Website Editorial The commit id we want to publish by commit id is ``f47c9a5bae4184e7b5ff2cb03b90b8ff86adec37`` -- Go back to Studio and click on |projectTools| -> Publishing +- Go back to Studio and click on ``Project Tools`` -> ``Publishing`` - Scroll down to the ``Publish on Demand`` section - Select the ``Publish changes made via direct git actions against the repository or pulled from a remote repository`` radio button -- Paste the commit id from the step where we got the commit id, then click on the ``Publish`` button +- Paste the commit id from the earlier step, fill in the ``Package Title`` and ``Submission Comment``, select the ``Publishing Target``, then click the ``Publish`` button .. _publish-everything: @@ -145,7 +132,9 @@ The **Publish everything** selection allows the user to publish all changes on t target you choose. For example, using the Website Editorial blueprint, to publish all the changes made in the sandbox repo, -simply select ``Publish everything`` and then choose the publishing target, then click on the ``Publish`` button. +simply select ``Publish everything`` and then fill in the ``Package Title`` and ``Submission Comment`` and choose the +``Publishing Target``. Remember to check the box confirming that you understand the entire site will be published. +Finally click on the ``Publish`` button. .. image:: /_static/images/site-admin/project-tools-publish-bulk.webp @@ -167,18 +156,24 @@ The **Publishing Queue** tab allows the user to see the items(publishing package | -**Publishing packages** contains the following information: +**Publishing packages** contain the following information: + +* ``Package Title``: title for the publishing package +* ``Publishing Target``: publishing package destination +* ``Submitter``: user that sent/requested publishing package +* ``Submission Comment``: submission comment for publishing package +* ``Status``: status of the publishing package and depending on the status, may contain the following: + + - ``Reviewer``: user that reviewed and approved/rejected the package + - ``Approved`` / ``Rejected``: whether the package is approved/rejected + - ``Comment`` / ``Reason``: approval comment provided/ rejection reason provided -* An ``id`` for the publishing package -* The ``target`` item is published to/to be published -* ``Username`` that sent/requested publishing package -* ``Submission comment`` -* ``State`` of the publishing package -* ``Scheduled Date`` for publishing the package +* ``Submitted On``: date package was submitted for publishing +* ``Scheduled For``: schedule for publishing the package * A list of file(s) contained in the publishing package with the following information: - * The ``content type`` - * The ``content path`` + * The content title + * The content path .. image:: /_static/images/site-admin/project-tools-publishing-package.webp @@ -189,18 +184,21 @@ The **Publishing Queue** tab allows the user to see the items(publishing package You can filter the publishing queue displayed, based on the following: -* ``Path Expression`` (e.g. simple regex ``/SOME/PATH/*``) * ``Publishing Target`` (a list of all available targets) * ``State`` of the publishing packages - The following are the applicable states to publishing packages. + The following are the applicable states for publishing packages. - * **All** - * **Ready for Live**: Item is scheduled and waiting in the queue to be published - * **Processing**: Item is being published - * **Completed**: Item has been published - * **Cancelled**: Item has been removed from the queue (publishing was cancelled) - * **Blocked**: Item is blocking the publishing queue + * **Ready for Live**: The package is ready to be published (this is conditional on package approvalState) + * **Processing**: The package is currently being processed + * **Live Success**: The package has been published to live target + * **Live Completed with Errors**: The package has been partially published to live target due to errors + * **Live Failed**: The package failed to be published to live target + * **Staging Success**: The package has been published to staging + * **Staging Completed with Errors**: The package has been partially published to staging target due to errors + * **Staging Failed**: The package failed to be published to staging target + * **Completed**: The package has been completed in at least one target + * **Cancelled**: The package has been cancelled .. image:: /_static/images/site-admin/project-tools-publish-queue-filter.webp @@ -226,3 +224,4 @@ Packages in the ``READY_FOR_LIVE`` state can be selected and the publishing pack :alt: Project Tools Publishing - Publishing Queue Filter Completed :align: center +| \ No newline at end of file diff --git a/source/by-role/common/project-tools/setting-workflow-states.rst b/source/by-role/common/project-tools/setting-workflow-states.rst index 71e970fa6..80bfeb0af 100644 --- a/source/by-role/common/project-tools/setting-workflow-states.rst +++ b/source/by-role/common/project-tools/setting-workflow-states.rst @@ -1,5 +1,5 @@ :is-up-to-date: True -:last-updated: 4.0.0 +:last-updated: 5.0.0 .. index:: Workflow States @@ -16,17 +16,23 @@ To manually set the workflow state of a file in your project, find the file/s yo :alt: Site Admin - Project Tools Set Workflow States :align: center -A dialog will launch prompting you to set the state for your selection, by clicking on the slider next to the state you want to set, then click on the ``Confirm`` button +| + +A dialog will launch prompting you to set the state for your selection. Click the slider next to the desired state, then click the ``Confirm`` button. .. image:: /_static/images/site-admin/project-config-select-state-dialog.webp :alt: Site Admin - Project Tools Select Workflow State Dialog :width: 70% :align: center +| + Here are the available workflow states: * Clear system processing * Clear user lock + * Clear new + * Clear modified * Set as published live * Clear as published live * Set as published to staging diff --git a/source/by-role/common/staging.rst b/source/by-role/common/staging.rst index 928cb74af..6c7ff7c2a 100644 --- a/source/by-role/common/staging.rst +++ b/source/by-role/common/staging.rst @@ -1,5 +1,5 @@ :is-up-to-date: True -:last-updated: 4.0.3 +:last-updated: 5.0.0 .. _staging-env: @@ -8,7 +8,7 @@ Configuring Publishing to Staging Target ======================================== CrafterCMS supports an intermediate publishing target, named ``staging``, where the project can be fully exercised with regards to system and integration points. This staging publishing target allows testing of your project. Once validated in staging, items can be pushed live. This ``staging`` publishing target precedes ``live``. -When staging is setup, the **Request Publish** and **Approve for Publish** dialogs gives the user the option to select to which publishing target to publish to: +When staging is set up, the **Publish** dialog gives the user the option to select which publishing target to publish to: .. image:: /_static/images/system-admin/staging-publish-option.webp :width: 75 %