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_typesense </ 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-typesense ">
364- < h1 class ="title "> connector_typesense</ 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-typesense ">
370+ < h1 > connector_typesense</ h1 >
366371<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
367372!! This file is generated by oca-gen-addon-readme !!
368373!! changes will be overwritten. !!
369374!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370- !! source digest: sha256:f09633c3af59b153f0eba3f876a9835676c430a6f39dd0dfa3545a924c80bc11
375+ !! source digest: sha256:676c8c7fdca3f944f4ca0874f86451534b70c921ba01e45e6a7b095ae0625295
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_typesense "> < 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_typesense "> < 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_typesense "> < 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_typesense "> < 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 > This addon provides the bases to implement addons to export information to
374379< a class ="reference external " href ="https://typesense.org "> Typesense</ a > indexes.</ p >
375380< p > < strong > Table of contents</ strong > </ p >
@@ -388,48 +393,48 @@ <h1 class="title">connector_typesense</h1>
388393</ ul >
389394</ div >
390395< div class ="section " id ="installation ">
391- < h1 > < a class ="toc-backref " href ="#toc-entry-1 "> Installation</ a > </ h1 >
396+ < h2 > < a class ="toc-backref " href ="#toc-entry-1 "> Installation</ a > </ h2 >
392397< p > This package requires a typesense search engine running.
393398Please read this for a [quick docker based setup](< a class ="reference external " href ="https://typesense.org/docs/guide/install-typesense.html#option-2-local-machine-self-hosting "> https://typesense.org/docs/guide/install-typesense.html#option-2-local-machine-self-hosting</ a > ).</ p >
394399</ div >
395400< div class ="section " id ="configuration ">
396- < h1 > < a class ="toc-backref " href ="#toc-entry-2 "> Configuration</ a > </ h1 >
401+ < h2 > < a class ="toc-backref " href ="#toc-entry-2 "> Configuration</ a > </ h2 >
397402< p > You have to configure (Host, Port, Protocol, Typesense API Key) in a new backend form view:</ p >
398403< p > Search Engine > Configuration > Backends</ p >
399404</ div >
400405< div class ="section " id ="usage ">
401- < h1 > < a class ="toc-backref " href ="#toc-entry-3 "> Usage</ a > </ h1 >
406+ < h2 > < a class ="toc-backref " href ="#toc-entry-3 "> Usage</ a > </ h2 >
402407< p > We recommend to use the typesense-dashboard for managing your typesense server.
403408I will allow you to configure the mapping of index with a nice UI.
404409Please take a look here: < a class ="reference external " href ="https://github.com/bfritscher/typesense-dashboard/releases "> https://github.com/bfritscher/typesense-dashboard/releases</ a > </ p >
405410</ div >
406411< div class ="section " id ="bug-tracker ">
407- < h1 > < a class ="toc-backref " href ="#toc-entry-4 "> Bug Tracker</ a > </ h1 >
412+ < h2 > < a class ="toc-backref " href ="#toc-entry-4 "> Bug Tracker</ a > </ h2 >
408413< p > Bugs are tracked on < a class ="reference external " href ="https://github.com/OCA/search-engine/issues "> GitHub Issues</ a > .
409414In case of trouble, please check there if your issue has already been reported.
410415If you spotted it first, help us to smash it by providing a detailed and welcomed
411416< a class ="reference external " href ="https://github.com/OCA/search-engine/issues/new?body=module:%20connector_typesense%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior** "> feedback</ a > .</ p >
412417< p > Do not contact contributors directly about support or help with technical issues.</ p >
413418</ div >
414419< div class ="section " id ="credits ">
415- < h1 > < a class ="toc-backref " href ="#toc-entry-5 "> Credits</ a > </ h1 >
420+ < h2 > < a class ="toc-backref " href ="#toc-entry-5 "> Credits</ a > </ h2 >
416421< div class ="section " id ="authors ">
417- < h2 > < a class ="toc-backref " href ="#toc-entry-6 "> Authors</ a > </ h2 >
422+ < h3 > < a class ="toc-backref " href ="#toc-entry-6 "> Authors</ a > </ h3 >
418423< ul class ="simple ">
419424< li > Derico</ li >
420425< li > Kencove</ li >
421426</ ul >
422427</ div >
423428< div class ="section " id ="contributors ">
424- < h2 > < a class ="toc-backref " href ="#toc-entry-7 "> Contributors</ a > </ h2 >
429+ < h3 > < a class ="toc-backref " href ="#toc-entry-7 "> Contributors</ a > </ h3 >
425430< ul class ="simple ">
426431< li > Maik Derstappen << a class ="reference external " href ="mailto:md@derico.de "> md@derico.de</ a > ></ li >
427432< li > Mohamed Alkobrosli << a class ="reference external " href ="mailto:malkobrosly@kencove.com "> malkobrosly@kencove.com</ a > ></ li >
428433< li > Sebastien BEAU << a class ="reference external " href ="mailto:sebastien.beau@akretion.com "> sebastien.beau@akretion.com</ a > ></ li >
429434</ ul >
430435</ div >
431436< div class ="section " id ="maintainers ">
432- < h2 > < a class ="toc-backref " href ="#toc-entry-8 "> Maintainers</ a > </ h2 >
437+ < h3 > < a class ="toc-backref " href ="#toc-entry-8 "> Maintainers</ a > </ h3 >
433438< p > This module is maintained by the OCA.</ p >
434439< a class ="reference external image-reference " href ="https://odoo-community.org ">
435440< img alt ="Odoo Community Association " src ="https://odoo-community.org/logo.png " />
@@ -442,5 +447,6 @@ <h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
442447</ div >
443448</ div >
444449</ div >
450+ </ div >
445451</ body >
446452</ html >
0 commit comments