Skip to content

Commit

Permalink
Issue IMCMS-579: Work through documentation
Browse files Browse the repository at this point in the history
- Create new icons and documentation;
- Refactor and clean up;
  • Loading branch information
Victor authored and Victor committed Jan 12, 2021
1 parent 3e9b6e1 commit 548df93
Show file tree
Hide file tree
Showing 28 changed files with 292 additions and 9 deletions.
14 changes: 14 additions & 0 deletions docs/content-management/document/base.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Base Management
In this article:
- `Introduction`_
- `Create Document`_
- `Remove Document`_
- `Edit Life Cycle`_
- `Edit Appearance`_
- `Edit Access`_
Expand Down Expand Up @@ -59,6 +60,19 @@ Today there are two way of document creation:
.. _label:
* nothing


---------------
Remove Document
---------------

Select multi remove documents in editors and select documents which we would want to remove.


#.

- Click on *Multi-Remove* and choose checkbox on document, which we would want to remove:
.. image:: base/_static/multi-remove.png

---------------
Edit Life Cycle
---------------
Expand Down
18 changes: 9 additions & 9 deletions docs/content-management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ Content Management
.. toctree::
:titlesonly:

document/index
admin-panel
text
image
loop
menu
user-property
category
role
document/index
admin-panel
text
image
loop
menu
user-property
category
role
30 changes: 30 additions & 0 deletions docs/content-management/superadmin-window/delete-document.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Delete Document Management
==========================


In this article:
- `Introduction`_
- `Delete Document`_

------------
Introduction
------------

This section describes how delete documents.

---------------
Delete document
---------------

Today, we can easy delete document via super admin window or via document editor (multi-remove) :doc:`Multi-Remove</content-management/document/base>`.


---------------
Delete Document
---------------

#.

- Click on field and write document id and click *DELETE* :

.. image:: delete-document/_static/delete-document.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file.
61 changes: 61 additions & 0 deletions docs/content-management/superadmin-window/index-cache.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
Index Cache Management
======================

In this article:
- `Introduction`_
- `Re-Index`_
- `Remove caches`_
- `Build Caches`_


------------
Introduction
------------

This article describes manager cache and indexes.

--------
Re-Index
--------

System easy can re-index all data from document to solr server:

#.
- Click to *Indexes*
.. image:: index-cache/_static/re-index.png

-------------
Remove caches
-------------

Remove all public documents cache:

#.
- Click to *Init*
.. image:: index-cache/_static/remove-public-cache.png

Remove all static web cache:

#.
- Click to *Init*
.. image:: index-cache/_static/remove-static-doc-cache.png

Remove other web cache:

#.
- Click to *Init*
.. image:: index-cache/_static/remove-other-cache.png

Also system can remove cache from single the document from *Page-Info* section *CACHE*

------------
Build Caches
------------

Imcms version 6 has new feature build caches for each pages or add pages to cache store.

#.
- Click to *Build caches*
.. image:: index-cache/_static/build-caches.png


Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions docs/content-management/superadmin-window/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Super Admin Window Management
=============================

.. toctree::
:titlesonly:

users
delete-document
files
link-validator
profile
index-cache
57 changes: 57 additions & 0 deletions docs/content-management/superadmin-window/link-validator.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
Link Validator Management
=========================

In this article:
- `Introduction`_
- `Start id`_
- `End id`_
- `Start validation`_
- `Flag Broken Links`_


------------
Introduction
------------

This section describes how validation links from range documents.

--------
Start id
--------
#.

- Click to number field and write start document id, where the links validation will start:

.. image:: link-validator/_static/start-id.png

------
End id
------

#.

- Click to number field and write enf document id, where the links validation will end:

.. image:: link-validator/_static/end-id.png

----------------
Start validation
----------------

#.

- Click on *Start the validation* and will be show all links from start id and end id (range):

.. image:: link-validator/_static/showLinks.png

-----------------
Flag Broken Links
-----------------

#.
- Select checkbox and list will show only broken links on the pages

.. image:: link-validator/_static/flag-broken-links.png



Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 52 additions & 0 deletions docs/content-management/superadmin-window/profile.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
Profile Management
==================

In this article:
- `Introduction`_
- `Create profile`_
- `Edit profile`_
- `Delete profile`_


------------
Introduction
------------

This article describes profile creating and displaying.

--------------
Create profile
--------------

#.
- Click to *CREATE NEW PROFILE* and will be show window for creating profile:

.. image:: profile/_static/create-profile.png

- Window creating new profile:

.. image:: profile/_static/creating-New-Profile.png

``Name`` - the name profile;
``Document name`` - document title or document identifier;

------------
Edit profile
------------

#.
- Select profile from list profiles and edit it:

.. image:: profile/_static/edit-profile.png

--------------
Delete profile
--------------

#.
- Select profile from list profiles and remove ir via cross:

.. image:: profile/_static/remove-profile.png



Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
57 changes: 57 additions & 0 deletions docs/content-management/superadmin-window/users.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
User Management
===============

In this article:
- `Introduction`_
- `Manager edit user`_
- `Create User`_
- `Edit User`_

------------
Introduction
------------

This article describes user creating and displaying.

-----------------
Manager edit user
-----------------

#.
Manager edit/show list users

.. image:: users/_static/UserEditManagement.png

``List users`` - button show list exists in system users;
``Search users`` - field for search users by any chars/word;
``User with role`` - drop down list, exist for select role for searching;


#.

Show all exist users in the system:

.. image:: users/_static/userList.png

-----------
Create User
-----------

In order to create new user need to press button *CREATE NEW USER* and then we will redirect to new window.


---------
Edit User
---------

#.

In order to edit selected user need to press button(PEN) and then we will redirect to edit window.

.. image:: users/_static/editUser.png






Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 548df93

Please sign in to comment.