Browse Source

[12.0][FIX] readme

14.0
hveficent 6 years ago
committed by Jesús Alan Ramos Rodríguez
parent
commit
75f9ec6aea
  1. 22
      base_user_role/README.rst
  2. 12
      base_user_role/readme/CONFIGURE.rst
  3. 4
      base_user_role/readme/ROADMAP.rst
  4. 2
      base_user_role/readme/USAGE.rst
  5. 59
      base_user_role/static/description/index.html

22
base_user_role/README.rst

@ -62,15 +62,21 @@ You can also define default roles for a new user by editing the user called
Roles:
.. image:: https://raw.githubusercontent.com/base_user_role/static/description/roles.png
.. figure:: https://raw.githubusercontent.com/OCA/server-backend/12.0/base_user_role/static/description/roles.png
:width: 80 %
:align: center
Add groups:
.. image:: https://raw.githubusercontent.com/base_user_role/static/description/role_groups.png
.. figure:: https://raw.githubusercontent.com/OCA/server-backend/12.0/base_user_role/static/description/role_groups.png
:width: 80 %
:align: center
Add users (with dates or not):
.. image:: https://raw.githubusercontent.com/base_user_role/static/description/role_users.png
.. figure:: https://raw.githubusercontent.com/OCA/server-backend/12.0/base_user_role/static/description/role_users.png
:width: 80 %
:align: center
Usage
=====
@ -87,15 +93,7 @@ To use this module, you need to:
#. Go to Configuration / Users / Users choose user and set Roles:
.. image:: https://raw.githubusercontent.com/base_user_role/static/description/user_form.png
Known issues / Roadmap
======================
Bugs are tracked on `GitHub Issues
<https://github.com/OCA/server-backend/issues>`_. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.
.. image:: https://raw.githubusercontent.com/OCA/server-backend/base_user_role/static/description/user_form.png
Bug Tracker
===========

12
base_user_role/readme/CONFIGURE.rst

@ -7,12 +7,18 @@ You can also define default roles for a new user by editing the user called
Roles:
.. image:: /base_user_role/static/description/roles.png
.. figure:: /OCA/server-backend/12.0/base_user_role/static/description/roles.png
:width: 80 %
:align: center
Add groups:
.. image:: /base_user_role/static/description/role_groups.png
.. figure:: /OCA/server-backend/12.0/base_user_role/static/description/role_groups.png
:width: 80 %
:align: center
Add users (with dates or not):
.. image:: /base_user_role/static/description/role_users.png
.. figure:: /OCA/server-backend/12.0/base_user_role/static/description/role_users.png
:width: 80 %
:align: center

4
base_user_role/readme/ROADMAP.rst

@ -1,4 +0,0 @@
Bugs are tracked on `GitHub Issues
<https://github.com/OCA/server-backend/issues>`_. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.

2
base_user_role/readme/USAGE.rst

@ -10,4 +10,4 @@ To use this module, you need to:
#. Go to Configuration / Users / Users choose user and set Roles:
.. image:: /base_user_role/static/description/user_form.png
.. image:: /OCA/server-backend/base_user_role/static/description/user_form.png

59
base_user_role/static/description/index.html

@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
<meta name="generator" content="Docutils 0.13.1: http://docutils.sourceforge.net/" />
<title>User roles</title>
<style type="text/css">
@ -391,38 +391,43 @@ are able to add and update user accounts in a scalable and reliable way.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id2">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="id3">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id4">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id5">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id6">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id7">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id8">Contributors</a></li>
<li><a class="reference internal" href="#other-credits" id="id9">Other credits</a><ul>
<li><a class="reference internal" href="#images" id="id10">Images</a></li>
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
<li><a class="reference internal" href="#other-credits" id="id7">Other credits</a><ul>
<li><a class="reference internal" href="#images" id="id8">Images</a></li>
</ul>
</li>
<li><a class="reference internal" href="#maintainers" id="id11">Maintainers</a></li>
<li><a class="reference internal" href="#maintainers" id="id9">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id2">Configuration</a></h1>
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
<p>To configure this module, you need to go to <em>Configuration / Users / Roles</em>,
and create a new role. From there, you can add groups to compose your role,
and then associate users to it.</p>
<p>You can also define default roles for a new user by editing the user called
“Default User”.</p>
<p>Roles:</p>
<img alt="https://raw.githubusercontent.com/base_user_role/static/description/roles.png" src="https://raw.githubusercontent.com/base_user_role/static/description/roles.png" />
<div class="figure align-center">
<img alt="https://raw.githubusercontent.com/OCA/server-backend/12.0/base_user_role/static/description/roles.png" src="https://raw.githubusercontent.com/OCA/server-backend/12.0/base_user_role/static/description/roles.png" style="width: 80%;" />
</div>
<p>Add groups:</p>
<img alt="https://raw.githubusercontent.com/base_user_role/static/description/role_groups.png" src="https://raw.githubusercontent.com/base_user_role/static/description/role_groups.png" />
<div class="figure align-center">
<img alt="https://raw.githubusercontent.com/OCA/server-backend/12.0/base_user_role/static/description/role_groups.png" src="https://raw.githubusercontent.com/OCA/server-backend/12.0/base_user_role/static/description/role_groups.png" style="width: 80%;" />
</div>
<p>Add users (with dates or not):</p>
<img alt="https://raw.githubusercontent.com/base_user_role/static/description/role_users.png" src="https://raw.githubusercontent.com/base_user_role/static/description/role_users.png" />
<div class="figure align-center">
<img alt="https://raw.githubusercontent.com/OCA/server-backend/12.0/base_user_role/static/description/role_users.png" src="https://raw.githubusercontent.com/OCA/server-backend/12.0/base_user_role/static/description/role_users.png" style="width: 80%;" />
</div>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id3">Usage</a></h1>
<h1><a class="toc-backref" href="#id2">Usage</a></h1>
<dl class="docutils">
<dt>[ This file must be present and contains the usage instructions</dt>
<dd>for end-users. As all other rst files included in the README,
@ -436,16 +441,10 @@ section). ]</dd>
<ol class="arabic simple">
<li>Go to Configuration / Users / Users choose user and set Roles:</li>
</ol>
<img alt="https://raw.githubusercontent.com/base_user_role/static/description/user_form.png" src="https://raw.githubusercontent.com/base_user_role/static/description/user_form.png" />
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id4">Known issues / Roadmap</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-backend/issues">GitHub Issues</a>. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.</p>
<img alt="https://raw.githubusercontent.com/OCA/server-backend/base_user_role/static/description/user_form.png" src="https://raw.githubusercontent.com/OCA/server-backend/base_user_role/static/description/user_form.png" />
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id5">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-backend/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
@ -453,15 +452,15 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id6">Credits</a></h1>
<h1><a class="toc-backref" href="#id4">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id7">Authors</a></h2>
<h2><a class="toc-backref" href="#id5">Authors</a></h2>
<ul class="simple">
<li>ABF OSIELL</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id8">Contributors</a></h2>
<h2><a class="toc-backref" href="#id6">Contributors</a></h2>
<ul class="simple">
<li>Sébastien Alix &lt;<a class="reference external" href="mailto:sebastien.alix&#64;osiell.com">sebastien.alix&#64;osiell.com</a>&gt;</li>
<li>Duc, Dao Dong &lt;<a class="reference external" href="mailto:duc.dd&#64;komit-consulting.com">duc.dd&#64;komit-consulting.com</a>&gt; (<a class="reference external" href="https://komit-consulting.com">https://komit-consulting.com</a>)</li>
@ -470,16 +469,16 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="other-credits">
<h2><a class="toc-backref" href="#id9">Other credits</a></h2>
<h2><a class="toc-backref" href="#id7">Other credits</a></h2>
<div class="section" id="images">
<h3><a class="toc-backref" href="#id10">Images</a></h3>
<h3><a class="toc-backref" href="#id8">Images</a></h3>
<ul class="simple">
<li>Oxygen Team: <a class="reference external" href="http://www.iconarchive.com/show/oxygen-icons-by-oxygen-icons.org/Actions-user-group-new-icon.html">Icon</a> (LGPL)</li>
</ul>
</div>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id11">Maintainers</a></h2>
<h2><a class="toc-backref" href="#id9">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose

Loading…
Cancel
Save