Skip to content

Commit

Permalink
[IMP] update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
huguesdk committed Aug 22, 2022
1 parent 35443a5 commit 150651f
Show file tree
Hide file tree
Showing 18 changed files with 560 additions and 62 deletions.
2 changes: 1 addition & 1 deletion cooperator/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Contributors
* Vincent Van Rossem
* Manuel Claeys Bouuaert
* Carmen Bianca Bakker
* hugues dekeyzer
* hugues de keyzer

Maintainers
~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion cooperator/readme/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
* Vincent Van Rossem
* Manuel Claeys Bouuaert
* Carmen Bianca Bakker
* hugues dekeyzer
* hugues de keyzer
7 changes: 4 additions & 3 deletions cooperator/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,8 @@ <h1 class="title">Cooperators</h1>
</ul>
<p>Configurations:</p>
<ul class="simple">
<li>set on the company a default payment term for the capital release requests.</li>
<li>on the company, set a default payment term for the capital release requests.</li>
<li>on the company, set the cooperator account.</li>
</ul>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
Expand Down Expand Up @@ -433,7 +434,7 @@ <h1><a class="toc-backref" href="#id1">Installation</a></h1>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h1>
<p>Gather and consolidate all easy_my_coop settings in the application parameters.</p>
<p>Gather and consolidate all cooperator settings in the application parameters.</p>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
Expand Down Expand Up @@ -462,7 +463,7 @@ <h2><a class="toc-backref" href="#id6">Contributors</a></h2>
<li>Vincent Van Rossem</li>
<li>Manuel Claeys Bouuaert</li>
<li>Carmen Bianca Bakker</li>
<li>hugues dekeyzer</li>
<li>hugues de keyzer</li>
</ul>
</li>
</ul>
Expand Down
32 changes: 27 additions & 5 deletions cooperator_api/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

/*
:Author: David Goodger ([email protected])
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
Expand Down Expand Up @@ -37,6 +37,14 @@
.hidden {
display: none }

.subscript {
vertical-align: sub;
font-size: smaller }

.superscript {
vertical-align: super;
font-size: smaller }

a.toc-backref {
text-decoration: none ;
color: black }
Expand Down Expand Up @@ -161,12 +169,12 @@
hr.docutils {
width: 75% }

img.align-left, .figure.align-left, object.align-left {
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }

img.align-right, .figure.align-right, object.align-right {
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
Expand All @@ -177,6 +185,11 @@
margin-right: auto;
}

table.align-center {
margin-left: auto;
margin-right: auto;
}

.align-left {
text-align: left }

Expand All @@ -194,6 +207,15 @@
/* div.align-center * { */
/* text-align: left } */

.align-top {
vertical-align: top }

.align-middle {
vertical-align: middle }

.align-bottom {
vertical-align: bottom }

ol.simple, ul.simple {
margin-bottom: 1em }

Expand Down Expand Up @@ -346,7 +368,7 @@ <h1 class="title">Cooperators API</h1>
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/coopiteasy/vertical-cooperative/tree/12.0/cooperator_api"><img alt="coopiteasy/vertical-cooperative" src="https://img.shields.io/badge/github-coopiteasy%2Fvertical--cooperative-lightgray.png?logo=github" /></a></p>
<p>Open Easy My Coop to the world: RESTful API.</p>
<p>Open Cooperators to the world: RESTful API.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
Expand All @@ -369,7 +391,7 @@ <h1><a class="toc-backref" href="#id1">Usage</a></h1>
<li>click create and select a user, save.</li>
<li>communicate the API-KEY to the structure.</li>
</ul>
<p>It is recommended to create a technical user for the structure belonging to the group “Easy My Coop User”.
<p>It is recommended to create a technical user for the structure belonging to the group “Cooperators User”.
For example, for the structure Coop IT Easy, create partner with</p>
<ul class="simple">
<li>name = coopiteasy-api-user</li>
Expand Down
28 changes: 25 additions & 3 deletions cooperator_api_logs/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

/*
:Author: David Goodger ([email protected])
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
:Copyright: This stylesheet has been placed in the public domain.
Default cascading style sheet for the HTML output of Docutils.
Expand Down Expand Up @@ -37,6 +37,14 @@
.hidden {
display: none }

.subscript {
vertical-align: sub;
font-size: smaller }

.superscript {
vertical-align: super;
font-size: smaller }

a.toc-backref {
text-decoration: none ;
color: black }
Expand Down Expand Up @@ -161,12 +169,12 @@
hr.docutils {
width: 75% }

img.align-left, .figure.align-left, object.align-left {
img.align-left, .figure.align-left, object.align-left, table.align-left {
clear: left ;
float: left ;
margin-right: 1em }

img.align-right, .figure.align-right, object.align-right {
img.align-right, .figure.align-right, object.align-right, table.align-right {
clear: right ;
float: right ;
margin-left: 1em }
Expand All @@ -177,6 +185,11 @@
margin-right: auto;
}

table.align-center {
margin-left: auto;
margin-right: auto;
}

.align-left {
text-align: left }

Expand All @@ -194,6 +207,15 @@
/* div.align-center * { */
/* text-align: left } */

.align-top {
vertical-align: top }

.align-middle {
vertical-align: middle }

.align-bottom {
vertical-align: bottom }

ol.simple, ul.simple {
margin-bottom: 1em }

Expand Down
11 changes: 11 additions & 0 deletions cooperator_website/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,17 @@ shares online.
.. contents::
:local:

Changelog
=========

12.0.3.0.0 (2022-06-23)
~~~~~~~~~~~~~~~~~~~~~~~

**Deprecations and Removals**

- Removed reCAPTCHA logic out of this module. Install
``cooperator_website_recaptcha`` to regain the functionality. (`#312 <https://github.com/coopiteasy/vertical-cooperative/issues/312>`_)

Bug Tracker
===========

Expand Down
7 changes: 7 additions & 0 deletions cooperator_website/readme/HISTORY.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
12.0.3.0.0 (2022-06-23)
~~~~~~~~~~~~~~~~~~~~~~~

**Deprecations and Removals**

- Removed reCAPTCHA logic out of this module. Install
``cooperator_website_recaptcha`` to regain the functionality. (`#312 <https://github.com/coopiteasy/vertical-cooperative/issues/312>`_)
2 changes: 0 additions & 2 deletions cooperator_website/readme/newsfragments/312.removal.rst

This file was deleted.

41 changes: 28 additions & 13 deletions cooperator_website/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils: http://docutils.sourceforge.net/" />
<title>Cooperator Website</title>
<title>Cooperators Website</title>
<style type="text/css">

/*
Expand Down Expand Up @@ -360,8 +360,8 @@
</style>
</head>
<body>
<div class="document" id="cooperator-website">
<h1 class="title">Cooperator Website</h1>
<div class="document" id="cooperators-website">
<h1 class="title">Cooperators Website</h1>

<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
Expand All @@ -373,39 +373,54 @@ <h1 class="title">Cooperator Website</h1>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#bug-tracker" id="id1">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id2">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id3">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id4">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id5">Maintainers</a></li>
<li><a class="reference internal" href="#changelog" id="id3">Changelog</a><ul>
<li><a class="reference internal" href="#id1" id="id4">12.0.3.0.0 (2022-06-23)</a></li>
</ul>
</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="#maintainers" id="id9">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="changelog">
<h1><a class="toc-backref" href="#id3">Changelog</a></h1>
<div class="section" id="id1">
<h2><a class="toc-backref" href="#id4">12.0.3.0.0 (2022-06-23)</a></h2>
<p><strong>Deprecations and Removals</strong></p>
<ul class="simple">
<li>Removed reCAPTCHA logic out of this module. Install
<tt class="docutils literal">cooperator_website_recaptcha</tt> to regain the functionality. (<a class="reference external" href="https://github.com/coopiteasy/vertical-cooperative/issues/312">#312</a>)</li>
</ul>
</div>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id1">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#id5">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/coopiteasy/vertical-cooperative/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
<a class="reference external" href="https://github.com/coopiteasy/vertical-cooperative/issues/new?body=module:%20cooperator_website%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<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="#id2">Credits</a></h1>
<h1><a class="toc-backref" href="#id6">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id3">Authors</a></h2>
<h2><a class="toc-backref" href="#id7">Authors</a></h2>
<ul class="simple">
<li>Coop IT Easy SC</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id4">Contributors</a></h2>
<h2><a class="toc-backref" href="#id8">Contributors</a></h2>
<ul class="simple">
<li>Coop IT Easy SC</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id5">Maintainers</a></h2>
<h2><a class="toc-backref" href="#id9">Maintainers</a></h2>
<p>This module is part of the <a class="reference external" href="https://github.com/coopiteasy/vertical-cooperative/tree/12.0/cooperator_website">coopiteasy/vertical-cooperative</a> project on GitHub.</p>
<p>You are welcome to contribute.</p>
</div>
Expand Down
Loading

0 comments on commit 150651f

Please sign in to comment.