Skip to content

Commit b0b5521

Browse files
HviorForgeFlowHviorForgeFlow
committed
Add README structure + some minor change
1 parent 95278d3 commit b0b5521

21 files changed

+134
-5
lines changed

‎README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
=======================
2+
Elasticsearch connector
3+
=======================
4+

‎elasticsearch_base/README.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
**This file is going to be generated by oca-gen-addon-readme.**
2+
3+
*Manual changes will be overwritten.*
4+
5+
Please provide content in the ``readme`` directory:
6+
7+
* **DESCRIPTION.rst** (required)
8+
* INSTALL.rst (optional)
9+
* CONFIGURE.rst (optional)
10+
* **USAGE.rst** (optional, highly recommended)
11+
* DEVELOP.rst (optional)
12+
* ROADMAP.rst (optional)
13+
* HISTORY.rst (optional, recommended)
14+
* **CONTRIBUTORS.rst** (optional, highly recommended)
15+
* CREDITS.rst (optional)
16+
17+
Content of this README will also be drawn from the addon manifest,
18+
from keys such as name, authors, maintainers, development_status,
19+
and license.
20+
21+
A good, one sentence summary in the manifest is also highly recommended.

‎elasticsearch_base/models/__init__.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,3 @@
44
from . import elasticsearch_document
55
from . import elasticsearch_host
66
from . import elasticsearch_index
7-
from . import elasticsearch_model

‎elasticsearch_base/models/elasticsearch_model.py

Whitespace-only changes.

‎elasticsearch_base/readme/CONFIGURE.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
You must run Odoo instance with an specific database adding `root` and
2+
`root.elasticsearch` channels.
3+
4+
To configure this module, you need to:
5+
6+
* Go to Elasticsearch > Hosts where you can configure connection
7+
with Elasticsearch

‎elasticsearch_base/readme/CONTRIBUTORS.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* Enric Tobella <[email protected]>

‎elasticsearch_base/readme/DESCRIPTION.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
This is a base module that allows to connect Odoo and Elasticsearch. It is
2+
build on top of the `connector`_ framework.
3+
4+
It is provided with Python Elasticsearch Client basic functionalities.
5+
6+
7+
.. _connector: https://github.com/OCA/connector

‎elasticsearch_cron/README.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
**This file is going to be generated by oca-gen-addon-readme.**
2+
3+
*Manual changes will be overwritten.*
4+
5+
Please provide content in the ``readme`` directory:
6+
7+
* **DESCRIPTION.rst** (required)
8+
* INSTALL.rst (optional)
9+
* CONFIGURE.rst (optional)
10+
* **USAGE.rst** (optional, highly recommended)
11+
* DEVELOP.rst (optional)
12+
* ROADMAP.rst (optional)
13+
* HISTORY.rst (optional, recommended)
14+
* **CONTRIBUTORS.rst** (optional, highly recommended)
15+
* CREDITS.rst (optional)
16+
17+
Content of this README will also be drawn from the addon manifest,
18+
from keys such as name, authors, maintainers, development_status,
19+
and license.
20+
21+
A good, one sentence summary in the manifest is also highly recommended.

‎elasticsearch_cron/__manifest__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html).
33

44
{
5-
'name': 'Elasticsearch modeler with cron',
5+
'name': 'Elasticsearch cron',
66
'version': '11.0.1.0.1',
77
'category': 'Elasticsearch connector',
88
'depends': [
99
'elasticsearch_modeler',
1010
],
1111
'author': 'Creu Blanca',
1212
'license': 'AGPL-3',
13-
'summary': 'Elasticsearch connector base',
13+
'summary': 'Elasticsearch cron',
1414
'data': [
1515
'views/elasticsearch_index_views.xml',
1616
],

‎elasticsearch_cron/readme/CONTRIBUTORS.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* Enric Tobella <[email protected]>

‎elasticsearch_cron/readme/DESCRIPTION.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This is a base module that allows to create cron jobs to update indexes.

‎elasticsearch_cron/readme/USAGE.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
To configure this module, you need to:
2+
3+
* Go to Elasticsearch > Indexes > where you can add indexes
4+
5+
* Fill Is cron

‎elasticsearch_direct/README.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
**This file is going to be generated by oca-gen-addon-readme.**
2+
3+
*Manual changes will be overwritten.*
4+
5+
Please provide content in the ``readme`` directory:
6+
7+
* **DESCRIPTION.rst** (required)
8+
* INSTALL.rst (optional)
9+
* CONFIGURE.rst (optional)
10+
* **USAGE.rst** (optional, highly recommended)
11+
* DEVELOP.rst (optional)
12+
* ROADMAP.rst (optional)
13+
* HISTORY.rst (optional, recommended)
14+
* **CONTRIBUTORS.rst** (optional, highly recommended)
15+
* CREDITS.rst (optional)
16+
17+
Content of this README will also be drawn from the addon manifest,
18+
from keys such as name, authors, maintainers, development_status,
19+
and license.
20+
21+
A good, one sentence summary in the manifest is also highly recommended.

‎elasticsearch_direct/__manifest__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
],
1111
'author': 'Creu Blanca',
1212
'license': 'AGPL-3',
13-
'summary': 'Elasticsearch connector base',
13+
'summary': 'Elasticsearch Direct modeler',
1414
'data': [
1515
'views/elasticsearch_index_views.xml',
1616
],

‎elasticsearch_direct/readme/DESCRIPTION.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TODO

‎elasticsearch_modeler/README.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
**This file is going to be generated by oca-gen-addon-readme.**
2+
3+
*Manual changes will be overwritten.*
4+
5+
Please provide content in the ``readme`` directory:
6+
7+
* **DESCRIPTION.rst** (required)
8+
* INSTALL.rst (optional)
9+
* CONFIGURE.rst (optional)
10+
* **USAGE.rst** (optional, highly recommended)
11+
* DEVELOP.rst (optional)
12+
* ROADMAP.rst (optional)
13+
* HISTORY.rst (optional, recommended)
14+
* **CONTRIBUTORS.rst** (optional, highly recommended)
15+
* CREDITS.rst (optional)
16+
17+
Content of this README will also be drawn from the addon manifest,
18+
from keys such as name, authors, maintainers, development_status,
19+
and license.
20+
21+
A good, one sentence summary in the manifest is also highly recommended.

‎elasticsearch_modeler/__manifest__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2017 Creu Blanca
1+
# Copyright 2017 Creu Blanca
22
# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html).
33

44
{

‎elasticsearch_modeler/readme/CONTRIBUTORS.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* Enric Tobella <[email protected]>

‎elasticsearch_modeler/readme/DESCRIPTION.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
This is module allows to configure index content manually from Odoo models.
2+

‎elasticsearch_modeler/readme/USAGE.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
To configure this module, you need to:
2+
3+
* Go to Elasticsearch > Indexes > where you can add indexes
4+
5+
* Create New Index with Modeler type.
6+
7+
* Choose Odoo model you want to export to ES
8+
9+
.. figure:: https://raw.githubusercontent.com/etobella/elasticsearch_connector/10.0/elasticsearch_modeler/static/description/create_modeler_index.png
10+
:alt: Sample Modeler Index
11+
:width: 80 %
12+
:align: center
13+
14+
* Add fields including relations O2M M2O & M2M nested fields.
15+
16+

‎elasticsearch_modeler/static/description/create_modeler_index.png

22.9 KB
Loading

0 commit comments

Comments
 (0)