This repository has been archived by the owner on Jan 7, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added documentation on Publishing Issues (#46)
- Loading branch information
1 parent
ed01155
commit 0c4fb06
Showing
25 changed files
with
154 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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.
Binary file added
BIN
+54.6 KB
doc/admin/contentstudio/images/issues/publishing-issues-create-issue-toolbar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+68.6 KB
doc/admin/contentstudio/images/issues/publishing-issues-create-issue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+98.3 KB
doc/admin/contentstudio/images/issues/publishing-issues-edit-mode.png
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.
Binary file added
BIN
+29.3 KB
doc/admin/contentstudio/images/issues/publishing-issues-list-empty.png
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.
Binary file added
BIN
+28.7 KB
doc/admin/contentstudio/images/issues/publishing-issues-new-empty.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+78.7 KB
doc/admin/contentstudio/images/issues/publishing-issues-new-issue.png
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.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
.. _issue_create: | ||
|
||
New Issue | ||
========= | ||
|
||
.. |issueicon| image:: images/issues/icon-publishing-issues.png | ||
.. |includechildrenicon| image:: images/issues/icon-include-children.png | ||
.. |backicon| image:: images/issues/icon-back-to-dialog.png | ||
|
||
There are several ways to create a new issue. | ||
|
||
From the Issue List dialog | ||
-------------------------- | ||
|
||
Click the |issueicon| icon in the top right corner of the :ref:`browse_view`. This will open a dialog with the :ref:`issue_list`. | ||
|
||
.. image:: images/issues/publishing-issues-list-empty.png | ||
|
||
In this dialog click the "New Issue" button to open the "Create Issue" dialog. | ||
|
||
.. image:: images/issues/publishing-issues-new-empty.png | ||
|
||
Fill out title and description of the new issue, select one or more assignees and content that is supposed to be published within the issue. | ||
Use the |includechildrenicon| icon to flag content items that must be published with all of their child items. Use "X" icons in the list | ||
to exclude items that should not be published within the issue. | ||
|
||
.. image:: images/issues/publishing-issues-new-issue.png | ||
|
||
Click "Create Issue" button to create the issue or "Cancel" to return to the list. | ||
|
||
|
||
From the Publishing Wizard | ||
-------------------------- | ||
|
||
Inside the Publishing Wizard you can expand the Publish button's dropdown menu and select "Create Issue" option. | ||
|
||
.. image:: images/issues/publishing-issues-create-issue.png | ||
|
||
This will open the "Create Issue" dialog similar to the one above except that the list of content items will be based on selection in the "Publishing Wizard". | ||
Use |backicon| in the top left corner of the dialog to return to the Publishing Wizard if you want to make changes to the list of contents. | ||
|
||
|
||
From the Publish button menu | ||
---------------------------- | ||
|
||
In the Content Grid select content items that you want to add to a new issue. Expand the dropdown menu of the Publish button in the grid's toolbar | ||
and select "Create Issue". Again, this will open the "Create Issue" dialog with preselected items from the grid selection. | ||
|
||
.. image:: images/issues/publishing-issues-create-issue-toolbar.png | ||
|
||
No matter which way was used to create a new issue, once it was successfully created the user will be redirected to the :ref:`new issue's details dialog <issue_details>`: | ||
|
||
.. image:: images/issues/publishing-issues-existing.png | ||
|
||
After a new issue is created, both creator of the issue and all of the assignees will be notified by email. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
.. _issue_details: | ||
|
||
Issue Details | ||
============= | ||
|
||
.. |backicon| image:: images/issues/icon-back-to-dialog.png | ||
.. image:: images/issues/publishing-issues-existing.png | ||
|
||
The dialog with issue details can be open from the :ref:`issue_list` or via direct link from an email confirmation sent to assignees. | ||
It will also open automatically after a new issue is created. | ||
By default the dialog is in read-only mode and shows issue title, id, brief summary, status, description, assignees and the list of contents. | ||
Use |backicon| in the top left corner to go back to the :ref:`issue_list`. | ||
|
||
"Edit Issue" button in the bottom-left corner can be used to switch the issue to :ref:`edit mode <issue_modify>` and make changes to it. | ||
Pressing the "Publish" button will publish all of the items in the issue along with their dependencies and - optionally - child items. | ||
After an issue is published its status will change from Open to Closed and user will be redirected back to the issue list. | ||
Both creator of the issue and all of the assignees will be notified by email that the issue was published and closed. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
.. _issue_list: | ||
|
||
Issue List | ||
========== | ||
|
||
.. |issueicon| image:: images/issues/icon-publishing-issues.png | ||
|
||
The list of Publishing Issues can be opened by clicking the |issueicon| icon in the top right corner of the :ref:`browse_view`. | ||
|
||
.. image:: images/issues/publishing-issues-list.png | ||
|
||
The list is split in two tabs: Open and Closed, with open and closed issues respectively. | ||
Filter on top of the list can be used to narrow down the list to only the issues assigned to you or created by you. | ||
Black circles next to each issue indicate assignees the issue is assigned to. | ||
Clicking an issue will open the :ref:`issue_details` dialog. | ||
"New Issue" button opens the :ref:`New Issue dialog <issue_create>`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
.. _issue_modify: | ||
|
||
Edit Issue | ||
========== | ||
|
||
An issue goes into edit mode with a click on the Edit Issue button in the :ref:`issue_details` dialog. | ||
|
||
.. image:: images/issues/publishing-issues-edit-mode.png | ||
|
||
Here you can change issue properties, assignees, the list of contents etc. | ||
Click "Save" button to apply the changes or "Cancel" to close edit mode without changes. | ||
After an issue is modified, both creator of the issue and all of the assignees will be notified of the changes by email. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
.. _issue_status: | ||
|
||
Issue Status | ||
============ | ||
|
||
Status of an issue can be changed from Open to Closed or back at any time (even in read-only mode) by clicking the status button in the | ||
:ref:`issue_details` dialog. This will expand a dropdown with available statuses - just select one and the issue will be updated at once. | ||
As always after issue modifications, an email will be sent to both creator of the issue and all of the assignees to notify them of the changes. | ||
|
||
Note that changing issue status will change its location in the Issue List - it will be moved from Open tab to Closed tab or the other way around. | ||
|
||
.. image:: images/issues/publishing-issues-status.png |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
.. _publishing_issues: | ||
|
||
Publishing Issues | ||
================= | ||
|
||
.. |issueicon| image:: images/issues/icon-publishing-issues.png | ||
.. |notificationicon| image:: images/issues/icon-issue-notification.png | ||
|
||
**Publishing Issues** is a way to create, delegate and follow up tasks for publishing one or several content items. | ||
The list of publishing issues can be open by clicking |issueicon| icon in the top right corner of the :ref:`browse_view`. | ||
A new issue can be created either from the Issue List dialog, :ref:`publish_wizard` or from the Publish button's menu in the Browse view's :ref:`toolbar_browse`. | ||
|
||
.. image:: images/issues/publishing-issues-list.png | ||
|
||
If current user has any open issues assigned to him this will be reflected on the Issue icon: |notificationicon|. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
issue-create | ||
issue-list | ||
issue-details | ||
issue-modify | ||
issue-status |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters