fix: unify connector documentations

README.md

@@ -72,7 +72,7 @@ We invite developers to join us in our mission to bring AI and data integration
 
 | Name                                                                                                                                      | Type                 | Status             | Release date   | Last update     |
 |-------------------------------------------------------------------------------------------------------------------------------------------|----------------------|--------------------|----------------|-----------------|
-| [**Adzuna**](./src/hrflow_connectors/v1/connectors/adzuna/README.md) | Job Board | :book: Open source | *08/09/2022* | *05/09/2024* |
+| [**Adzuna**](./src/hrflow_connectors/v2/connectors/adzuna/README.md) | Job Board | :book: Open source | *08/09/2022* | *05/09/2024* |
 | [**Carrevolutis**](./src/hrflow_connectors/v1/connectors/carrevolutis/README.md) | Job Board | :book: Open source | *20/03/2024* | *05/09/2024* |
 | [**Jobology**](./src/hrflow_connectors/v1/connectors/jobology/README.md) | Job Board | :book: Open source | *21/12/2022* | *05/09/2024* |
 | [**Meteojob**](./src/hrflow_connectors/v1/connectors/meteojob/README.md) | Job Board | :book: Open source | *15/02/2024* | *05/09/2024* |

src/hrflow_connectors/v2/__init__.py

@@ -1,4 +1,5 @@
 from hrflow_connectors.v2.connectors.admen import Admen
+from hrflow_connectors.v2.connectors.adzuna import Adzuna
 from hrflow_connectors.v2.connectors.bullhorn import Bullhorn
 from hrflow_connectors.v2.connectors.hubspot import Hubspot
 from hrflow_connectors.v2.connectors.recruitee import Recruitee
@@ -11,4 +12,12 @@
     hrflow_connectors_docs as hrflow_connectors_docs,
 )
 
-__CONNECTORS__ = [Bullhorn, ZohoRecruit, Admen, SmartRecruiters, Hubspot, Recruitee]
+__CONNECTORS__ = [
+    Bullhorn,
+    ZohoRecruit,
+    Admen,
+    SmartRecruiters,
+    Hubspot,
+    Recruitee,
+    Adzuna,
+]

src/hrflow_connectors/v2/connectors/admen/README.md

@@ -1,7 +1,7 @@
 # 📖 Summary
 - [📖 Summary](#📖-summary)
-- [💼 About Admen](#💼-about-admen)
-  - [😍 Why is it a big deal for Admen customers & partners?](#😍-why-is-it-a-big-deal-for-admen-customers--partners)
+- [💼 About Ad-men](#💼-about-ad-men)
+  - [😍 Why is it a big deal for Ad-men customers & partners?](#😍-why-is-it-a-big-deal-for-ad-men-customers--partners)
 - [🔧 How does it work?](#🔧-how-does-it-work)
   - [📊 Data integration capabilities:](#📊-data-integration-capabilities)
   - [🧠 Artificial Intelligence capabilities:](#🧠-artificial-intelligence-capabilities)
@@ -11,31 +11,37 @@
 - [👏 Special Thanks](#👏-special-thanks)
 
 
-# 💼 About Admen
+# 💼 About Ad-men
 
 > 
 Need an efficient, high-performance HR solution for managing your applications?
 Choose AD-Men, the No. 1 software for recruitment agencies.
 
 
 
-## 😍 Why is it a big deal for Admen customers & partners?
+## 😍 Why is it a big deal for Ad-men customers & partners?
 
 This new connector will enable:
-- ⚡ A Fastlane Talent & Workforce data integration for Admen customers & partners
-- 🤖 Cutting-edge AI-powered Talent Experiences & Recruiter Experiences for Admen customers
+- ⚡ A Fastlane Talent & Workforce data integration for Ad-men customers & partners
+- 🤖 Cutting-edge AI-powered Talent Experiences & Recruiter Experiences for Ad-men customers
 
 #  🔧 How does it work?
 ## 📊 Data integration capabilities:
-- ⬅️ Send Profiles data from Admen to a Destination of your choice.
-- ➡️ Send Profiles data from a Source of your choice to Admen.
-- ⬅️ Send Jobs data from Admen to a Destination of your choice.
-- ➡️ Send Jobs data from a Source of your choice to Admen.
+- ⬅️ Send Profiles data from Ad-men to a Destination of your choice.
+- ➡️ Send Profiles data from a Source of your choice to Ad-men.
+- ⬅️ Send Jobs data from Ad-men to a Destination of your choice.
+- ➡️ Send Jobs data from a Source of your choice to Ad-men.
 
+</p>
+
+<p align="center">
+<image src=https://github.com/user-attachments/assets/cac7da42-2146-4e67-ac8c-7e37f4550554 width=90% height=100% 
+>
+</p>
 
 ## 🧠 Artificial Intelligence capabilities:
 - Extract, Structure, and Categorize Talent & Workforce data
-- Search, Score, and Match Profiles & Jobs with our APIs and AI Widgets (**Matching Custom Tab in Admen**)
+- Search, Score, and Match Profiles & Jobs with our APIs and AI Widgets (**Matching Custom Tab in Ad-men**)
 
 
 # 🔌 Connector Actions
@@ -56,12 +62,6 @@ This new connector will enable:
 
 </p>
 
-</p>
-
-<p align="center">
-<image src=https://github.com/user-attachments/assets/cac7da42-2146-4e67-ac8c-7e37f4550554 width=90% height=100% 
->
-</p>
 
 # 💍 Quick Start Examples
 
@@ -83,8 +83,8 @@ For more code details checkout connector code.
 
 # 🔗 Useful Links
 
-- 📄Visit [Admen](https://www.ad-rh.com/) to learn more.
-- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/admen) on our Github.
+- 📄 Visit [Ad-men](https://www.ad-rh.com/) to learn more.
+- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/v2/connectors/admen) on our Github.
 
 
 # 👏 Special Thanks

src/hrflow_connectors/v2/connectors/hubspot/README.md

@@ -1,31 +1,42 @@
 # 📖 Summary
-- [📖 Summary](#-summary)
-- [📝 About Hubspot](#-about-hubspot)
-- [📊 Data Flow](#-data-flow)
-- [🔌 Connector Actions](#-connector-actions)
-- [🐍 Quick Start Example](#-quick-start-example)
-- [🔗 Useful Links](#-useful-links)
-- [👏 Special Thanks](#-special-thanks)
+- [📖 Summary](#📖-summary)
+- [💼 About Hubspot](#💼-about-hubspot)
+  - [😍 Why is it a big deal for Hubspot customers & partners?](#😍-why-is-it-a-big-deal-for-hubspot-customers--partners)
+- [🔧 How does it work?](#🔧-how-does-it-work)
+  - [📊 Data integration capabilities:](#📊-data-integration-capabilities)
+  - [🧠 Artificial Intelligence capabilities:](#🧠-artificial-intelligence-capabilities)
+- [🔌 Connector Actions](#🔌-connector-actions)
+- [💍 Quick Start Examples](#💍-quick-start-examples)
+- [🔗 Useful Links](#🔗-useful-links)
+- [👏 Special Thanks](#👏-special-thanks)
 
 
-# 📝 About Hubspot
+# 💼 About Hubspot
 
-HubSpot is a CRM platform with all the software, integrations, and resources you need to connect marketing, sales, content management, and customer service.
+> HubSpot is a CRM platform with all the software, integrations, and resources you need to connect marketing, sales, content management, and customer service.
 
 
-<p align="center">
-<image src=https://user-images.githubusercontent.com/107410704/213674431-f11f9805-6c43-456b-bb3d-b60ebf698415.jpg width=90% height=100% >
-</p>
+## 😍 Why is it a big deal for Hubspot customers & partners?
 
+This new connector will enable:
+- ⚡ A Fastlane Talent & Workforce data integration for Hubspot customers & partners
+- 🤖 Cutting-edge AI-powered Talent Experiences & Recruiter Experiences for Hubspot customers
 
-# 📊 Data Flow
-In this section, we outline the data flow between different components of the connector. The following schema provides a graphical representation of the data exchange process
+#  🔧 How does it work?
+## 📊 Data integration capabilities:
+- ⬅️ Send Profiles data from Hubspot to a Destination of your choice.
+- ➡️ Send Profiles data from a Source of your choice to Hubspot.
+- ⬅️ Send Jobs data from Hubspot to a Destination of your choice.
+- ➡️ Send Jobs data from a Source of your choice to Hubspot.
 
 <p align="center">
 
 <image src=https://user-images.githubusercontent.com/107410704/213676477-70dd9009-f41b-4659-a58c-41f53a92f7d4.jpg width=90% height=100% >
 </p>
 
+## 🧠 Artificial Intelligence capabilities:
+- Extract, Structure, and Categorize Talent & Workforce data
+- Search, Score, and Match Profiles & Jobs with our APIs and AI Widgets (**Matching Custom Tab in Hubspot**)
 
 
 # 🔌 Connector Actions
@@ -46,8 +57,9 @@ In this section, we outline the data flow between different components of the co
 
 # 💍 Quick Start Examples
 
-
 To make sure you can successfully run the latest versions of the example scripts, you have to **install the package from PyPi**.
+
+
 To browse the examples of actions corresponding to released versions of 🤗 this connector, you just need to import the module like this :
 
 
@@ -57,14 +69,14 @@ To browse the examples of actions corresponding to released versions of 🤗 thi
 
 Once the connector module is imported, you can leverage all the different actions that it offers.
 
-For more code details checkout connector code
+For more code details checkout connector code.
 
 
 # 🔗 Useful Links
 
 - 📄Visit [Hubspot](https://www.hubspot.com) to learn more.
 - ⚙️ API documentation : (https://developers.hubspot.com/docs/api/overview)
-- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/hubspot) on our Github.
+- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/v2/connectors/hubspot) on our Github.
 
 
 # 👏 Special Thanks

src/hrflow_connectors/v2/connectors/hubspot/connector.py

@@ -74,7 +74,11 @@ def format_hubspot_contact_for_archive(hubspot_contact: t.Dict) -> t.Dict:
     name="Hubspot",
     type=ConnectorType.CRM,
     subtype="hubspot",
-    description="",
+    description=(
+        "HubSpot is a CRM platform with all the software, integrations, and resources"
+        " you need to connect marketing, sales, content management, and customer"
+        " service."
+    ),
     url="https://www.hubspot.com/",
     warehouse=HubspotWarehouse,
     flows=(

src/hrflow_connectors/v2/connectors/recruitee/README.md

@@ -29,6 +29,9 @@ This new connector will enable:
 - ⬅️ Send Jobs data from Recruitee to a Destination of your choice.
 - ➡️ Send Jobs data from a Source of your choice to Recruitee.
 
+<p align="center">
+<image src=https://github.com/Riminder/hrflow-connectors/assets/57711045/ff726feb-d580-40f8-82b2-6c1132cebd8e width=90% height=100% >
+</p>
 
 ## 🧠 Artificial Intelligence capabilities:
 - Extract, Structure, and Categorize Talent & Workforce data
@@ -53,13 +56,12 @@ This new connector will enable:
 
 </p>
 
-<p align="center">
-<image src=https://github.com/Riminder/hrflow-connectors/assets/57711045/ff726feb-d580-40f8-82b2-6c1132cebd8e width=90% height=100% >
-</p>
 
 # 💍 Quick Start Examples
 
 To make sure you can successfully run the latest versions of the example scripts, you have to **install the package from PyPi**.
+
+
 To browse the examples of actions corresponding to released versions of 🤗 this connector, you just need to import the module like this :
 
 
@@ -71,11 +73,13 @@ Once the connector module is imported, you can leverage all the different action
 
 For more code details checkout connector code.
 
+
 # 🔗 Useful Links
 
-- 📄Visit [Recruitee](https://recruitee.com/) to learn more.
+- 📄 Visit [Recruitee](https://recruitee.com/) to learn more.
 - ⚙️ API documentation : [Recruitee API](https://api.recruitee.com/docs/index.html)
-- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/recruitee) on our Github.
+- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/v2/connectors/recruitee) on our Github.
+
 
 
 # 👏 Special Thanks

src/hrflow_connectors/v2/connectors/smartrecruiters/README.md

@@ -15,13 +15,6 @@
 
 > Move beyond applicant tracking systems (ATS) with an enterprise-grade recruiting platform designed for the modern workforce. SmartRecruiters' Talent Acquisition Suite provides everything needed to attract, select, and hire great talent.
 
-<p align="center">
-<image src=https://user-images.githubusercontent.com/57711045/214608440-2d838ca1-cdd9-49ca-ac3b-25d65f06994a.png width=90% height=100% >
-</p>
-
-<p align="center">
-<image src=https://user-images.githubusercontent.com/57711045/214608101-4a496152-8aec-4528-afd0-b0712f9c5010.png width=90% height=100% >
-</p>
 
 ## 😍 Why is it a big deal for Smartrecruiters customers & partners?
 
@@ -36,6 +29,9 @@ This new connector will enable:
 - ⬅️ Send Jobs data from Smartrecruiters to a Destination of your choice.
 - ➡️ Send Jobs data from a Source of your choice to Smartrecruiters.
 
+<p align="center">
+<image src=https://user-images.githubusercontent.com/57711045/214609749-f47466cc-efe9-4132-b81b-dc0dcfe77464.png width=90% height=100% >
+</p>
 
 ## 🧠 Artificial Intelligence capabilities:
 - Extract, Structure, and Categorize Talent & Workforce data
@@ -60,10 +56,6 @@ This new connector will enable:
 
 </p>
 
-<p align="center">
-<image src=https://user-images.githubusercontent.com/57711045/214609749-f47466cc-efe9-4132-b81b-dc0dcfe77464.png width=90% height=100% >
-</p>
-
 
 # 💍 Quick Start Examples
 
@@ -79,14 +71,15 @@ To browse the examples of actions corresponding to released versions of 🤗 thi
 
 
 Once the connector module is imported, you can leverage all the different actions that it offers.
+
 For more code details checkout connector code.
 
 
 # 🔗 Useful Links
 
-- 📄Visit [SmartRecruiters](https://www.smartrecruiters.com/) to learn more.
+- 📄 Visit [Smartrecruiters](https://www.smartrecruiters.com/) to learn more.
 - ⚙️ API documentation : (https://developers.smartrecruiters.com/doc)
-- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/smartrecruiters) on our Github.
+- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/v2/connectors/smartrecruiters) on our Github.
 
 
 # 👏 Special Thanks

src/hrflow_connectors/v2/connectors/zohorecruit/README.md

@@ -1,7 +1,7 @@
 # 📖 Summary
 - [📖 Summary](#📖-summary)
-- [💼 About Zohorecruit](#💼-about-zohorecruit)
-  - [😍 Why is it a big deal for Zohorecruit customers & partners?](#😍-why-is-it-a-big-deal-for-zohorecruit-customers--partners)
+- [💼 About Zoho recruit](#💼-about-zoho-recruit)
+  - [😍 Why is it a big deal for Zoho recruit customers & partners?](#😍-why-is-it-a-big-deal-for-zoho-recruit-customers--partners)
 - [🔧 How does it work?](#🔧-how-does-it-work)
   - [📊 Data integration capabilities:](#📊-data-integration-capabilities)
   - [🧠 Artificial Intelligence capabilities:](#🧠-artificial-intelligence-capabilities)
@@ -11,28 +11,28 @@
 - [👏 Special Thanks](#👏-special-thanks)
 
 
-# 💼 About Zohorecruit
+# 💼 About Zoho recruit
 
 > Zoho Recruit offers a powerful ATS and CRM in a single recruitment platform. With scalability, customization, and remote hiring tools, Recruit has everything your staffing agency or internal HR team needs to match the right candidate to the right role.
 
 
-## 😍 Why is it a big deal for Zohorecruit customers & partners?
+## 😍 Why is it a big deal for Zoho recruit customers & partners?
 
 This new connector will enable:
-- ⚡ A Fastlane Talent & Workforce data integration for Zohorecruit customers & partners
-- 🤖 Cutting-edge AI-powered Talent Experiences & Recruiter Experiences for Zohorecruit customers
+- ⚡ A Fastlane Talent & Workforce data integration for Zoho recruit customers & partners
+- 🤖 Cutting-edge AI-powered Talent Experiences & Recruiter Experiences for Zoho recruit customers
 
 #  🔧 How does it work?
 ## 📊 Data integration capabilities:
-- ⬅️ Send Profiles data from Zohorecruit to a Destination of your choice.
-- ➡️ Send Profiles data from a Source of your choice to Zohorecruit.
-- ⬅️ Send Jobs data from Zohorecruit to a Destination of your choice.
-- ➡️ Send Jobs data from a Source of your choice to Zohorecruit.
+- ⬅️ Send Profiles data from Zoho recruit to a Destination of your choice.
+- ➡️ Send Profiles data from a Source of your choice to Zoho recruit.
+- ⬅️ Send Jobs data from Zoho recruit to a Destination of your choice.
+- ➡️ Send Jobs data from a Source of your choice to Zoho recruit.
 
 
 ## 🧠 Artificial Intelligence capabilities:
 - Extract, Structure, and Categorize Talent & Workforce data
-- Search, Score, and Match Profiles & Jobs with our APIs and AI Widgets (**Matching Custom Tab in Zohorecruit**)
+- Search, Score, and Match Profiles & Jobs with our APIs and AI Widgets (**Matching Custom Tab in Zoho recruit**)
 
 
 # 🔌 Connector Actions
@@ -53,11 +53,6 @@ This new connector will enable:
 
 </p>
 
-<p align="center">
-<image src=https://github.com/user-attachments/assets/0c646581-8bce-4e54-b52d-a20353fc459c width=90% height=100% 
->
-</p>
-
 
 # 💍 Quick Start Examples
 
@@ -66,10 +61,6 @@ To make sure you can successfully run the latest versions of the example scripts
 
 To browse the examples of actions corresponding to released versions of 🤗 this connector, you just need to import the module like this :
 
-<p align="center">
-<image src=https://github.com/user-attachments/assets/4b16200f-81e2-4766-8f2d-b2ee8bd5e470 width=90% height=100% 
->
-</p>
 
 Once the connector module is imported, you can leverage all the different actions that it offers.
 
@@ -78,9 +69,9 @@ For more code details checkout connector code.
 
 # 🔗 Useful Links
 
-- 📄Visit [Zohorecruit](https://zoho.com/recruit/) to learn more.
+- 📄 Visit [Zoho recruit](https://zoho.com/recruit/) to learn more.
 - ⚙️ API documentation : (https://www.zoho.com/recruit/developer-guide/apiv2/)
-- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/zohorecruit) on our Github.
+- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/v2/connectors/zohorecruit) on our Github.
 
 
 # 👏 Special Thanks