Skip to content
This repository has been archived by the owner on Jan 7, 2021. It is now read-only.

Commit

Permalink
Added documentation on Publishing Issues (#46)
Browse files Browse the repository at this point in the history
  • Loading branch information
alansemenov committed Jul 11, 2017
1 parent ed01155 commit 0c4fb06
Show file tree
Hide file tree
Showing 25 changed files with 154 additions and 13 deletions.
2 changes: 1 addition & 1 deletion doc/admin/contentstudio/browse-view.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ left is the :ref:`content_tree` where all the sites and content can be found. To
which displays a preview of the selected content. On the far right is the :ref:`detail_panel` that may be toggled on and off with the |detailicon| icon
in the top right corner.

.. image:: images/content-studio.jpg
.. image:: images/content-studio.png

.. toctree::
:maxdepth: 1
Expand Down
23 changes: 13 additions & 10 deletions doc/admin/contentstudio/detail-panel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,19 @@ Detail panel
The detail panel displays built-in and custom widgets with information about the content, selected in the tree grid.
To see it, click the |detailicon| button in the top right corner. This reveals the panel selector, which by default show details about
the content. The details are split into several boxes that show:
* Icon, name and path of selected content
* Content status (Online, Offline, or Modified)
* Permissions: The permissions section has three parts. First it shows an unlock icon |unlockicon| if the content has the role **Everyone**, which means the content is viewable
without authentication. Second, it lists the users that have access to the selected content at each access level, for example, "Can Read" or
"Full Access". Third, it has a link to edit permissions if the logged in user has the **Content Manager Administrator** role or other
applied permissions to edit the content.
* Basic information about the selected content, including type, application, language, owner, timestamps and ID
* Rendering Mode, which reveals if the content is rendered by a custom built page, a specifically selected page template, or an
automatically selected page template.
* File attachments

* Icon, name and path of selected content

* Content status (Online, Offline, or Modified)

* Permissions: The permissions section has three parts. First it shows an unlock icon |unlockicon| if the content has the role **Everyone**, which means the content is viewable without authentication. Second, it lists the users that have access to the selected content at each access level, for example, "Can Read" or "Full Access". Third, it has a link to edit permissions if the logged in user has the **Content Manager Administrator** role or other applied permissions to edit the content.

* Basic information about the selected content, including type, application, language, owner, timestamps and ID

* Rendering Mode, which reveals if the content is rendered by a custom built page, a specifically selected page template, or an automatically selected page template.

* File attachments


.. image:: images/content-detail-panel.png

Expand Down
Binary file modified doc/admin/contentstudio/images/content-studio.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.
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.
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.
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.
1 change: 1 addition & 0 deletions doc/admin/contentstudio/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ view** appears when content is created or edited and will open in a new browser

browse-view
content-editor
publishing-issues
content-types
actions
shortcuts
55 changes: 55 additions & 0 deletions doc/admin/contentstudio/issue-create.rst
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.
17 changes: 17 additions & 0 deletions doc/admin/contentstudio/issue-details.rst
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.
16 changes: 16 additions & 0 deletions doc/admin/contentstudio/issue-list.rst
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>`.
12 changes: 12 additions & 0 deletions doc/admin/contentstudio/issue-modify.rst
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.
12 changes: 12 additions & 0 deletions doc/admin/contentstudio/issue-status.rst
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
2 changes: 2 additions & 0 deletions doc/admin/contentstudio/publish.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ When a published content is "deleted", the "Delete item" dialogue offers a check
not checked then the content's status will be **pending delete** and it will still be visible outside of the Content Studio. Content that is
pending delete must be published, unpublished, or "instantly deleted" before it is actually removed from the master branch.

.. _publish_wizard:

Publishing wizard
-----------------

Expand Down
24 changes: 24 additions & 0 deletions doc/admin/contentstudio/publishing-issues.rst
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
3 changes: 1 addition & 2 deletions doc/tutorials/my-first-app/page-templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ selected in the content pane, so make sure you select the "Hello World" site bef
habit of right-clicking the desired parent content and selecting "New" from the context menu. This way you will never accidentally create a
content in the wrong place.

.. tip:: From Enonic XP 6.11, The Detail Panel on the far right of the :ref:`browse_view` has a little box showing the rendering mode.
Compare your favorite country to other countries that are rendered automatically:
.. tip:: From Enonic XP 6.11, The Detail Panel on the far right of the :ref:`browse_view` has a little box showing the rendering mode. Compare your favorite country to other countries that are rendered automatically:

.. image:: images/rendering-mode-view.png

Expand Down

0 comments on commit 0c4fb06

Please sign in to comment.