33< head >
44< meta http-equiv ="Content-Type " content ="text/html; charset=utf-8 " />
55< meta name ="generator " content ="Docutils: https://docutils.sourceforge.io/ " />
6- < title > Connector Search Engine </ title >
6+ < title > README.rst </ title >
77< style type ="text/css ">
88
99/*
360360</ style >
361361</ head >
362362< body >
363- < div class ="document " id ="connector-search-engine ">
364- < h1 class ="title "> Connector Search Engine</ h1 >
363+ < div class ="document ">
365364
365+
366+ < a class ="reference external image-reference " href ="https://odoo-community.org/get-involved?utm_source=readme ">
367+ < img alt ="Odoo Community Association " src ="https://odoo-community.org/readme-banner-image " />
368+ </ a >
369+ < div class ="section " id ="connector-search-engine ">
370+ < h1 > Connector Search Engine</ h1 >
366371<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
367372!! This file is generated by oca-gen-addon-readme !!
368373!! changes will be overwritten. !!
369374!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370- !! source digest: sha256:1de927a1bba38e9e39f9f9f4dee380a42613136c9b1b3b7fedf494d6ab8679f5
375+ !! source digest: sha256:12a9925a7bb242f7c36cb13ee91325a75ff6b0c7f008cb9511ac82c5c970349c
371376!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372- < p > < a class ="reference external image-reference " 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 image-reference " 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 image-reference " href ="https://github.com/OCA/search-engine/tree/18.0/connector_search_engine "> < img alt ="OCA/search-engine " src ="https://img.shields.io/badge/github-OCA%2Fsearch--engine-lightgray.png?logo=github " /> </ a > < a class ="reference external image-reference " href ="https://translation.odoo-community.org/projects/search-engine-18-0/search-engine-18-0-connector_search_engine "> < img alt ="Translate me on Weblate " src ="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png " /> </ a > < a class ="reference external image-reference " href ="https://runboat.odoo-community.org/builds?repo=OCA/search-engine&target_branch=18.0 "> < img alt ="Try me on Runboat " src ="https://img.shields.io/badge/runboat-Try%20me-875A7B.png " /> </ a > </ p >
377+ < p > < a class ="reference external image-reference " 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 image-reference " href ="http://www.gnu.org/licenses/agpl-3.0-standalone.html "> < img alt ="License: AGPL-3 " src ="https://img.shields.io/badge/license-AGPL--3-blue.png " /> </ a > < a class ="reference external image-reference " href ="https://github.com/OCA/search-engine/tree/18.0/connector_search_engine "> < img alt ="OCA/search-engine " src ="https://img.shields.io/badge/github-OCA%2Fsearch--engine-lightgray.png?logo=github " /> </ a > < a class ="reference external image-reference " href ="https://translation.odoo-community.org/projects/search-engine-18-0/search-engine-18-0-connector_search_engine "> < img alt ="Translate me on Weblate " src ="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png " /> </ a > < a class ="reference external image-reference " href ="https://runboat.odoo-community.org/builds?repo=OCA/search-engine&target_branch=18.0 "> < img alt ="Try me on Runboat " src ="https://img.shields.io/badge/runboat-Try%20me-875A7B.png " /> </ a > </ p >
373378< p > Base module for connecting Odoo with external search engines. This addon
374379is intended to be used as a base for other addons that implement
375380specific search engines. It’s designed to be easily extensible and
@@ -403,7 +408,7 @@ <h1 class="title">Connector Search Engine</h1>
403408</ ul >
404409</ div >
405410< div class ="section " id ="installation ">
406- < h1 > < a class ="toc-backref " href ="#toc-entry-1 "> Installation</ a > </ h1 >
411+ < h2 > < a class ="toc-backref " href ="#toc-entry-1 "> Installation</ a > </ h2 >
407412< p > This addon uses the native json python package provided by python. When
408413a json for a record is recomputed, the new value is compared to the
409414original one to see if an export to the search engine index is needed.
@@ -416,9 +421,9 @@ <h1><a class="toc-backref" href="#toc-entry-1">Installation</a></h1>
416421</ pre >
417422</ div >
418423< div class ="section " id ="usage ">
419- < h1 > < a class ="toc-backref " href ="#toc-entry-2 "> Usage</ a > </ h1 >
424+ < h2 > < a class ="toc-backref " href ="#toc-entry-2 "> Usage</ a > </ h2 >
420425< div class ="section " id ="overview ">
421- < h2 > < a class ="toc-backref " href ="#toc-entry-3 "> Overview</ a > </ h2 >
426+ < h3 > < a class ="toc-backref " href ="#toc-entry-3 "> Overview</ a > </ h3 >
422427< p > A search engine is a system designed to store information in a way that
423428makes it easy to find through search and analytics queries. The main
424429difference between a search engine and a database is that a search
@@ -480,7 +485,7 @@ <h2><a class="toc-backref" href="#toc-entry-3">Overview</a></h2>
480485</ ul >
481486</ div >
482487< div class ="section " id ="indexing-lifecycle ">
483- < h2 > < a class ="toc-backref " href ="#toc-entry-4 "> Indexing lifecycle</ a > </ h2 >
488+ < h3 > < a class ="toc-backref " href ="#toc-entry-4 "> Indexing lifecycle</ a > </ h3 >
484489< p > The indexing lifecycle is based on the following steps:</ p >
485490< ul class ="simple ">
486491< li > When a record is added to an index, a binding is created and marked as
@@ -529,17 +534,17 @@ <h2><a class="toc-backref" href="#toc-entry-4">Indexing lifecycle</a></h2>
529534</ div >
530535</ div >
531536< div class ="section " id ="known-issues-roadmap ">
532- < h1 > < a class ="toc-backref " href ="#toc-entry-5 "> Known issues / Roadmap</ a > </ h1 >
537+ < h2 > < a class ="toc-backref " href ="#toc-entry-5 "> Known issues / Roadmap</ a > </ h2 >
533538< ul class ="simple ">
534539< li > Implement generic trigger for binding based on ir.export linked to the
535540index (the aim is to set the binding to be updated if we modify a
536541field configured in the exporter)</ li >
537542</ ul >
538543</ div >
539544< div class ="section " id ="changelog ">
540- < h1 > < a class ="toc-backref " href ="#toc-entry-6 "> Changelog</ a > </ h1 >
545+ < h2 > < a class ="toc-backref " href ="#toc-entry-6 "> Changelog</ a > </ h2 >
541546< div class ="section " id ="section-1 ">
542- < h2 > < a class ="toc-backref " href ="#toc-entry-7 "> 16.0.0.1.7 (2023-12-15)</ a > </ h2 >
547+ < h3 > < a class ="toc-backref " href ="#toc-entry-7 "> 16.0.0.1.7 (2023-12-15)</ a > </ h3 >
543548< p > < strong > Bugfixes</ strong > </ p >
544549< ul >
545550< li > < p class ="first "> Ensure that the record’s model is compatible with the index’s model
@@ -561,7 +566,7 @@ <h2><a class="toc-backref" href="#toc-entry-7">16.0.0.1.7 (2023-12-15)</a></h2>
561566</ ul >
562567</ div >
563568< div class ="section " id ="section-2 ">
564- < h2 > < a class ="toc-backref " href ="#toc-entry-8 "> 16.0.0.1.4 (2023-11-29)</ a > </ h2 >
569+ < h3 > < a class ="toc-backref " href ="#toc-entry-8 "> 16.0.0.1.4 (2023-11-29)</ a > </ h3 >
565570< p > < strong > Bugfixes</ strong > </ p >
566571< ul >
567572< li > < p class ="first "> Fix error when calling the methods < em > export_record</ em > or < em > delete_record</ em >
@@ -577,7 +582,7 @@ <h2><a class="toc-backref" href="#toc-entry-8">16.0.0.1.4 (2023-11-29)</a></h2>
577582</ ul >
578583</ div >
579584< div class ="section " id ="section-3 ">
580- < h2 > < a class ="toc-backref " href ="#toc-entry-9 "> 16.0.0.1.2 (2023-11-28)</ a > </ h2 >
585+ < h3 > < a class ="toc-backref " href ="#toc-entry-9 "> 16.0.0.1.2 (2023-11-28)</ a > </ h3 >
581586< p > < strong > Bugfixes</ strong > </ p >
582587< ul >
583588< li > < p class ="first "> Add missing description on the “se.binding.state.updater” model. As
@@ -589,7 +594,7 @@ <h2><a class="toc-backref" href="#toc-entry-9">16.0.0.1.2 (2023-11-28)</a></h2>
589594</ ul >
590595</ div >
591596< div class ="section " id ="section-4 ">
592- < h2 > < a class ="toc-backref " href ="#toc-entry-10 "> 16.0.0.1.1 (2023-10-13)</ a > </ h2 >
597+ < h3 > < a class ="toc-backref " href ="#toc-entry-10 "> 16.0.0.1.1 (2023-10-13)</ a > </ h3 >
593598< p > < strong > Bugfixes</ strong > </ p >
594599< ul class ="simple ">
595600< li > Fixes cache issue with the < em > se_binding_ids</ em > field on the
@@ -602,7 +607,7 @@ <h2><a class="toc-backref" href="#toc-entry-10">16.0.0.1.1 (2023-10-13)</a></h2>
602607</ ul >
603608</ div >
604609< div class ="section " id ="section-5 ">
605- < h2 > < a class ="toc-backref " href ="#toc-entry-11 "> 16.0.0.1.0 (2023-10-13)</ a > </ h2 >
610+ < h3 > < a class ="toc-backref " href ="#toc-entry-11 "> 16.0.0.1.0 (2023-10-13)</ a > </ h3 >
606611< p > < strong > Features</ strong > </ p >
607612< ul >
608613< li > < p class ="first "> A new action < strong > Update state</ strong > is now available on < em > Search Engine
@@ -624,30 +629,30 @@ <h2><a class="toc-backref" href="#toc-entry-11">16.0.0.1.0 (2023-10-13)</a></h2>
624629</ ul >
625630</ div >
626631< div class ="section " id ="x-y-z-yyyy-mm-dd ">
627- < h2 > < a class ="toc-backref " href ="#toc-entry-12 "> 12.0.x.y.z (YYYY-MM-DD)</ a > </ h2 >
632+ < h3 > < a class ="toc-backref " href ="#toc-entry-12 "> 12.0.x.y.z (YYYY-MM-DD)</ a > </ h3 >
628633< p > TODO</ p >
629634</ div >
630635</ div >
631636< div class ="section " id ="bug-tracker ">
632- < h1 > < a class ="toc-backref " href ="#toc-entry-13 "> Bug Tracker</ a > </ h1 >
637+ < h2 > < a class ="toc-backref " href ="#toc-entry-13 "> Bug Tracker</ a > </ h2 >
633638< p > Bugs are tracked on < a class ="reference external " href ="https://github.com/OCA/search-engine/issues "> GitHub Issues</ a > .
634639In case of trouble, please check there if your issue has already been reported.
635640If you spotted it first, help us to smash it by providing a detailed and welcomed
636641< a class ="reference external " href ="https://github.com/OCA/search-engine/issues/new?body=module:%20connector_search_engine%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior** "> feedback</ a > .</ p >
637642< p > Do not contact contributors directly about support or help with technical issues.</ p >
638643</ div >
639644< div class ="section " id ="credits ">
640- < h1 > < a class ="toc-backref " href ="#toc-entry-14 "> Credits</ a > </ h1 >
645+ < h2 > < a class ="toc-backref " href ="#toc-entry-14 "> Credits</ a > </ h2 >
641646< div class ="section " id ="authors ">
642- < h2 > < a class ="toc-backref " href ="#toc-entry-15 "> Authors</ a > </ h2 >
647+ < h3 > < a class ="toc-backref " href ="#toc-entry-15 "> Authors</ a > </ h3 >
643648< ul class ="simple ">
644649< li > Akretion</ li >
645650< li > ACSONE SA/NV</ li >
646651< li > Camptocamp</ li >
647652</ ul >
648653</ div >
649654< div class ="section " id ="contributors ">
650- < h2 > < a class ="toc-backref " href ="#toc-entry-16 "> Contributors</ a > </ h2 >
655+ < h3 > < a class ="toc-backref " href ="#toc-entry-16 "> Contributors</ a > </ h3 >
651656< ul class ="simple ">
652657< li > Sébastien BEAU << a class ="reference external " href ="mailto:sebastien.beau@akretion.com "> sebastien.beau@akretion.com</ a > ></ li >
653658< li > Laurent Mignon << a class ="reference external " href ="mailto:laurent.mignon@acsone.eu "> laurent.mignon@acsone.eu</ a > ></ li >
@@ -657,7 +662,7 @@ <h2><a class="toc-backref" href="#toc-entry-16">Contributors</a></h2>
657662</ ul >
658663</ div >
659664< div class ="section " id ="maintainers ">
660- < h2 > < a class ="toc-backref " href ="#toc-entry-17 "> Maintainers</ a > </ h2 >
665+ < h3 > < a class ="toc-backref " href ="#toc-entry-17 "> Maintainers</ a > </ h3 >
661666< p > This module is maintained by the OCA.</ p >
662667< a class ="reference external image-reference " href ="https://odoo-community.org ">
663668< img alt ="Odoo Community Association " src ="https://odoo-community.org/logo.png " />
@@ -670,5 +675,6 @@ <h2><a class="toc-backref" href="#toc-entry-17">Maintainers</a></h2>
670675</ div >
671676</ div >
672677</ div >
678+ </ div >
673679</ body >
674680</ html >
0 commit comments