Skip to content

Commit

Permalink
Added more intel on Managing Users
Browse files Browse the repository at this point in the history
  • Loading branch information
notorigine committed Jul 9, 2015
1 parent 45b1ba4 commit 900c243
Show file tree
Hide file tree
Showing 8 changed files with 53 additions and 28 deletions.
6 changes: 3 additions & 3 deletions user/documents-system/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Managing documents
==================

You can manage documents via the 'Document' icon in the toolbar. You can either upload , embed, randomize documents, and even have a look at unused documents in your website.
You can manage documents via the *Document* icon in the toolbar. You can either upload , embed, randomly downloaded documents, and even have a look at unused documents in your website.

.. image:: ./img/toolbar_document.png
:align: center
Expand Down Expand Up @@ -33,15 +33,15 @@ Here is the trickiest part of the Documents section. You can have embedded docum
Random document
---------------

'Random' is a cool feature that allows to upload random documents to your website from Splashbase. It uses REST API and it works pretty well.
*Random* is a cool feature that allows to download random documents to your website from Splashbase.

.. image:: ./img/random_document.png
:align: center

Unused document
---------------

Clicking 'Unused document' allows you to gather every unused documents on your website, so you can clean your database and get rid of useless documents.
Clicking *Unused document* allows you to gather every unused documents on your website, so you can clean your database and get rid of useless documents.


.. image:: ./img/unused_document.png
Expand Down
41 changes: 22 additions & 19 deletions user/nodes-system/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,53 +5,53 @@ Managing node-types and nodes

This is a simple guide on how to create and manage nodes using Roadiz CLI, add and remove node fields, or even how to import nodes.

First and foremost, you need to create a new node type before creating any kind of node.
First and foremost, you need to create a new node-type before creating any kind of node.

If you want to know more about what a node type is, please visit the other section of the developer documentation.
If you want to know more about what a node-type is, please visit the other section of the developer documentation.

When working with Roadiz in the back-office, you can easily manage node types via the 'Construction' icon in the toolbar.
When working with Roadiz in the back-office, you can easily manage node-types via the *Construction* icon in the toolbar.

.. image:: ./img/manage_nodetype_toolbar.png
:align: center

Add node-type
-------------

Once you have landed on the Node Types page (yourWebSiteURL/rz-admin/node-types), you can create node types by clicking on 'Add a node type'.
Once you have landed on the Node-Types page (*https://mywebsite.com/rz-admin/node-types*), you can create node-types by clicking on *Add a node-type*.

.. note ::
You can export and import a node-type if you have a json file. See 'Other action' for more information.
You can export and import a node-type if you have a .json file. See ``Other action* for more information.
.. image:: ./img/create_nodetype_button.png
:align: center

Upon filling the two mandatory settings 'Name' (that developpers will use) and 'Display Name' (that back-office users will see), you are now ready to create your first node type.
Upon filling the two mandatory settings *Name* (that developpers will use) and *Display Name* (that back-office users will see), you are now ready to create your first node type.

.. warning ::
Be careful when you name your node-type though, 'Name' field can't be changed once the node-type is created. See 'Delete node-type' section to know how to delete a node-type.
Be careful when you name your node-type though, ``Name* field can't be changed once the node-type is created. See *Delete node-type* section to know how to delete a node-type.
.. image:: ./img/add_nodetype.png
:align: center

Other options ('Visible', 'Newsletter node-type', 'Node-type hides its nodes' and customizable color) aren't required and can always be altered later on.
Other options (*Visible*, *Newsletter node-type*, *Node-type hides its nodes* and customizable color) aren't required and can always be altered later on.

You have now created your first node-type ! It now appears on the node-type page along other node-types and you can now manage its fields.
You have now created your first node-type! It now appears on the node-type page along other node-types and you can now manage its fields.

.. image:: ./img/created_nodetype.png
:align: center

Delete node
-----------

Made a typo when creating a node-type ? No longer in need of a node-type ? You can delete it by simply clicking the trashcan icon on the Node Types page (yourWebSiteURL/rz-admin/node-types).
Made a typo when creating a node-type? No longer in need of a node-type ? You can delete it by simply clicking the trashcan icon on the Node Types page (*https://mywebsite.com/rz-admin/node-types*).

.. image:: ./img/delete_nodetype.png
:align: center

Adding node field
-----------------

To add fields to your newly-created node-type, click the 'Manage node-type fields' icon.
To add fields to your newly-created node-type, click the *Manage node-type fields* icon.

.. image:: ./img/manage_nodetype_fields.png
:align: center
Expand All @@ -63,10 +63,13 @@ Then click on 'Add a node-type field' button.

Fill in the form to create a new field :

- Name : what developers will use
- Label : what back-office users will see
- Type : single choice option that will define the content (basic text, markdown text, documents, email, number, single or multiple choice, children nodes etc.)
- Description, Group name, Visible, Indexed, Default values, Min length, Max length (optionnal)
- *Name*: what developers will use
- *Label*: what back-office users will see
- *Type*: single choice option that will define the content (basic text, markdown text, documents, email, number, single or multiple choice, children nodes etc.)
- *Description*, *Group name*, *Visible*, *Indexed*, *Default values*, *Min length*, *Max length* (optional)

.. info ::
*Default values* is an interesting field as you can specify what kind of node-types that can be linked to this node-type. You can also use it as a filter in the explorer, and only show those default values.
.. image:: ./img/add_nodetype_field.png
:align: center
Expand All @@ -79,7 +82,7 @@ From one website to another, you can export node-types as .rzt files.
.. image:: ./img/export_nodetype.png
:align: center

An .rzt file should look like this when you open it in any editor (it is basically a json file) :
An .rzt file should look like this when you open it in any editor (it is basically a .json file):

.. code-block:: json
Expand Down Expand Up @@ -128,10 +131,10 @@ An .rzt file should look like this when you open it in any editor (it is basical
}
Notice the three fields that have been added to this 'Page' node-type.
Notice the three fields that have been added to this *Page* node-type.

You can write an .rzt file yourself if you feel like it, but it is probably easier to simply export type-nodes from existing website, then import it on your new website.
It can be easily done by clicking on 'Import node-type' button, then selecting it via your explorer.
You can write an .rzt file yourself if you feel like it, but it is probably easier to simply export node-types from existing website, then import it on your new website.
It can be easily done by clicking on *Import node-type* button, then selecting it via your explorer.

.. image:: ./img/import_nodetype.png
:align: center
Expand Down
Binary file added user/users/img/add_role_user.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user/users/img/add_user_button.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user/users/img/add_user_form.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user/users/img/add_user_toolbar.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user/users/img/remove_user.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 28 additions & 6 deletions user/users/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,56 @@
Managing users
==============

It is possible to manage users with roadiz CLI.
This is a simple guide on how to create and manage users using Roadiz CLI.

There are two ways of adding users, via the back-office and in command-line, both will be displayed in each section.

When working with Roadiz in the back-office, you can easily manage users via the *User system* icon in the toolbar.

.. image:: ./img/add_user_toolbar.png
:align: center

Add user
--------

The command ``bin/roadiz core:users --create loginname`` starts a new interactive user creation session.
It's kinda basical. You will create a new user with login and email, you can also choose if it's a backend user and if it's a superadmin.
You can add users simply by clicking *Add an user* button.

.. image:: ./img/add_user_button.png
:align: center

The command-line ``bin/roadiz core:users --create loginname`` starts a new interactive user creation session.
You will create a new user with login and email, you can also choose if it's a backend user and if it's a superadmin.

Delete user
-----------

You can remove users by clicking the trashcan icon.

.. image:: ./img/remove_user.png
:align: center

The command ``bin/roadiz core:users --delete loginname`` delete the user "loginname".

Adding role
-----------

You can add roles to users. If you want to add ``ROLE_SUPERADMIN`` role to user "test", this will be the command.
You can edit a users profile the same way you edit a node-type. You can add roles in the *Roles* tab.

.. image:: ./img/add_role_user.png
:align: center

If you want to add ``ROLE_SUPERADMIN`` role to "test" user, it would look like this in command-line:

.. code-block:: console
bin/roadiz core:users test --add-roles ROLE_SUPERADMIN
You can add multiple roles at the same time, you just need to use the "," separator without space.
You can add multiple roles at the same time, you just need to use a comma separator without space.

Other action
------------

It's possible to enable or disable users with ``--enable`` or ``--disable`` argument.
It is possible to enable or disable users with ``--enable`` or ``--disable`` argument.
If a user doesn't remember his password, you can regenerate it with the ``--regenerate`` argument.

For more informations and more actions, we invite you to use the command:
Expand Down

0 comments on commit 900c243

Please sign in to comment.