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:ecebea0ab860ebe72b980a4b887ff5f41a2df1e83403adf20b013c3c49074bea
375+ !! source digest: sha256:bf21cc03b5386ce044f5cb2215673930b61f1b4bce507aeda6db16d1fe6c4f5c
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/16.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-16-0/search-engine-16-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=16.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/16.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-16-0/search-engine-16-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=16.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 is
374379intended to be used as a base for other addons that implement specific search
375380engines. It’s designed to be easily extensible and modular.</ p >
@@ -402,7 +407,7 @@ <h1 class="title">Connector Search Engine</h1>
402407</ ul >
403408</ div >
404409< div class ="section " id ="installation ">
405- < h1 > < a class ="toc-backref " href ="#toc-entry-1 "> Installation</ a > </ h1 >
410+ < h2 > < a class ="toc-backref " href ="#toc-entry-1 "> Installation</ a > </ h2 >
406411< p > This addon uses the native json python package provided by python. When
407412a json for a record is recomputed, the new value is compared to the original
408413one to see if an export to the search engine index is needed. This is
@@ -414,9 +419,9 @@ <h1><a class="toc-backref" href="#toc-entry-1">Installation</a></h1>
414419</ pre >
415420</ div >
416421< div class ="section " id ="usage ">
417- < h1 > < a class ="toc-backref " href ="#toc-entry-2 "> Usage</ a > </ h1 >
422+ < h2 > < a class ="toc-backref " href ="#toc-entry-2 "> Usage</ a > </ h2 >
418423< div class ="section " id ="overview ">
419- < h2 > < a class ="toc-backref " href ="#toc-entry-3 "> Overview</ a > </ h2 >
424+ < h3 > < a class ="toc-backref " href ="#toc-entry-3 "> Overview</ a > </ h3 >
420425< p > A search engine is a system designed to store information in a way that makes
421426it easy to find through search and analytics queries. The main difference
422427between a search engine and a database is that a search engine is optimized
@@ -474,7 +479,7 @@ <h2><a class="toc-backref" href="#toc-entry-3">Overview</a></h2>
474479</ ul >
475480</ div >
476481< div class ="section " id ="indexing-lifecycle ">
477- < h2 > < a class ="toc-backref " href ="#toc-entry-4 "> Indexing lifecycle</ a > </ h2 >
482+ < h3 > < a class ="toc-backref " href ="#toc-entry-4 "> Indexing lifecycle</ a > </ h3 >
478483< p > The indexing lifecycle is based on the following steps:</ p >
479484< ul class ="simple ">
480485< li > When a record is added to an index, a binding is created and marked as to be
@@ -519,7 +524,7 @@ <h2><a class="toc-backref" href="#toc-entry-4">Indexing lifecycle</a></h2>
519524</ div >
520525</ div >
521526< div class ="section " id ="known-issues-roadmap ">
522- < h1 > < a class ="toc-backref " href ="#toc-entry-5 "> Known issues / Roadmap</ a > </ h1 >
527+ < h2 > < a class ="toc-backref " href ="#toc-entry-5 "> Known issues / Roadmap</ a > </ h2 >
523528< ul class ="simple ">
524529< li > Implement generic trigger for binding
525530based on ir.export linked to the index
@@ -528,9 +533,9 @@ <h1><a class="toc-backref" href="#toc-entry-5">Known issues / Roadmap</a></h1>
528533</ ul >
529534</ div >
530535< div class ="section " id ="changelog ">
531- < h1 > < a class ="toc-backref " href ="#toc-entry-6 "> Changelog</ a > </ h1 >
536+ < h2 > < a class ="toc-backref " href ="#toc-entry-6 "> Changelog</ a > </ h2 >
532537< div class ="section " id ="section-1 ">
533- < h2 > < a class ="toc-backref " href ="#toc-entry-7 "> 16.0.0.1.7 (2023-12-15)</ a > </ h2 >
538+ < h3 > < a class ="toc-backref " href ="#toc-entry-7 "> 16.0.0.1.7 (2023-12-15)</ a > </ h3 >
534539< p > < strong > Bugfixes</ strong > </ p >
535540< ul >
536541< li > < p class ="first "> Ensure that the record’s model is compatible with the index’s model before
@@ -548,7 +553,7 @@ <h2><a class="toc-backref" href="#toc-entry-7">16.0.0.1.7 (2023-12-15)</a></h2>
548553</ ul >
549554</ div >
550555< div class ="section " id ="section-2 ">
551- < h2 > < a class ="toc-backref " href ="#toc-entry-8 "> 16.0.0.1.4 (2023-11-29)</ a > </ h2 >
556+ < h3 > < a class ="toc-backref " href ="#toc-entry-8 "> 16.0.0.1.4 (2023-11-29)</ a > </ h3 >
552557< p > < strong > Bugfixes</ strong > </ p >
553558< ul >
554559< li > < p class ="first "> Fix error when calling the methods < em > export_record</ em > or < em > delete_record</ em > from
@@ -562,7 +567,7 @@ <h2><a class="toc-backref" href="#toc-entry-8">16.0.0.1.4 (2023-11-29)</a></h2>
562567</ ul >
563568</ div >
564569< div class ="section " id ="section-3 ">
565- < h2 > < a class ="toc-backref " href ="#toc-entry-9 "> 16.0.0.1.2 (2023-11-28)</ a > </ h2 >
570+ < h3 > < a class ="toc-backref " href ="#toc-entry-9 "> 16.0.0.1.2 (2023-11-28)</ a > </ h3 >
566571< p > < strong > Bugfixes</ strong > </ p >
567572< ul >
568573< li > < p class ="first "> Add missing description on the “se.binding.state.updater” model. As well as
@@ -573,7 +578,7 @@ <h2><a class="toc-backref" href="#toc-entry-9">16.0.0.1.2 (2023-11-28)</a></h2>
573578</ ul >
574579</ div >
575580< div class ="section " id ="section-4 ">
576- < h2 > < a class ="toc-backref " href ="#toc-entry-10 "> 16.0.0.1.1 (2023-10-13)</ a > </ h2 >
581+ < h3 > < a class ="toc-backref " href ="#toc-entry-10 "> 16.0.0.1.1 (2023-10-13)</ a > </ h3 >
577582< p > < strong > Bugfixes</ strong > </ p >
578583< ul class ="simple ">
579584< li > Fixes cache issue with the < em > se_binding_ids</ em > field on the < em > s.indexable.record</ em >
@@ -584,7 +589,7 @@ <h2><a class="toc-backref" href="#toc-entry-10">16.0.0.1.1 (2023-10-13)</a></h2>
584589</ ul >
585590</ div >
586591< div class ="section " id ="section-5 ">
587- < h2 > < a class ="toc-backref " href ="#toc-entry-11 "> 16.0.0.1.0 (2023-10-13)</ a > </ h2 >
592+ < h3 > < a class ="toc-backref " href ="#toc-entry-11 "> 16.0.0.1.0 (2023-10-13)</ a > </ h3 >
588593< p > < strong > Features</ strong > </ p >
589594< ul >
590595< li > < p class ="first "> A new action < strong > Update state</ strong > is now available on < em > Search Engine Record</ em > objects.
@@ -602,30 +607,30 @@ <h2><a class="toc-backref" href="#toc-entry-11">16.0.0.1.0 (2023-10-13)</a></h2>
602607</ ul >
603608</ div >
604609< div class ="section " id ="x-y-z-yyyy-mm-dd ">
605- < h2 > < a class ="toc-backref " href ="#toc-entry-12 "> 12.0.x.y.z (YYYY-MM-DD)</ a > </ h2 >
610+ < h3 > < a class ="toc-backref " href ="#toc-entry-12 "> 12.0.x.y.z (YYYY-MM-DD)</ a > </ h3 >
606611< p > TODO</ p >
607612</ div >
608613</ div >
609614< div class ="section " id ="bug-tracker ">
610- < h1 > < a class ="toc-backref " href ="#toc-entry-13 "> Bug Tracker</ a > </ h1 >
615+ < h2 > < a class ="toc-backref " href ="#toc-entry-13 "> Bug Tracker</ a > </ h2 >
611616< p > Bugs are tracked on < a class ="reference external " href ="https://github.com/OCA/search-engine/issues "> GitHub Issues</ a > .
612617In case of trouble, please check there if your issue has already been reported.
613618If you spotted it first, help us to smash it by providing a detailed and welcomed
614619< a class ="reference external " href ="https://github.com/OCA/search-engine/issues/new?body=module:%20connector_search_engine%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior** "> feedback</ a > .</ p >
615620< p > Do not contact contributors directly about support or help with technical issues.</ p >
616621</ div >
617622< div class ="section " id ="credits ">
618- < h1 > < a class ="toc-backref " href ="#toc-entry-14 "> Credits</ a > </ h1 >
623+ < h2 > < a class ="toc-backref " href ="#toc-entry-14 "> Credits</ a > </ h2 >
619624< div class ="section " id ="authors ">
620- < h2 > < a class ="toc-backref " href ="#toc-entry-15 "> Authors</ a > </ h2 >
625+ < h3 > < a class ="toc-backref " href ="#toc-entry-15 "> Authors</ a > </ h3 >
621626< ul class ="simple ">
622627< li > Akretion</ li >
623628< li > ACSONE SA/NV</ li >
624629< li > Camptocamp</ li >
625630</ ul >
626631</ div >
627632< div class ="section " id ="contributors ">
628- < h2 > < a class ="toc-backref " href ="#toc-entry-16 "> Contributors</ a > </ h2 >
633+ < h3 > < a class ="toc-backref " href ="#toc-entry-16 "> Contributors</ a > </ h3 >
629634< ul class ="simple ">
630635< li > Sébastien BEAU << a class ="reference external " href ="mailto:sebastien.beau@akretion.com "> sebastien.beau@akretion.com</ a > ></ li >
631636< li > Laurent Mignon << a class ="reference external " href ="mailto:laurent.mignon@acsone.eu "> laurent.mignon@acsone.eu</ a > ></ li >
@@ -634,7 +639,7 @@ <h2><a class="toc-backref" href="#toc-entry-16">Contributors</a></h2>
634639</ ul >
635640</ div >
636641< div class ="section " id ="maintainers ">
637- < h2 > < a class ="toc-backref " href ="#toc-entry-17 "> Maintainers</ a > </ h2 >
642+ < h3 > < a class ="toc-backref " href ="#toc-entry-17 "> Maintainers</ a > </ h3 >
638643< p > This module is maintained by the OCA.</ p >
639644< a class ="reference external image-reference " href ="https://odoo-community.org ">
640645< img alt ="Odoo Community Association " src ="https://odoo-community.org/logo.png " />
@@ -647,5 +652,6 @@ <h2><a class="toc-backref" href="#toc-entry-17">Maintainers</a></h2>
647652</ div >
648653</ div >
649654</ div >
655+ </ div >
650656</ body >
651657</ html >
0 commit comments