Skip to content

Commit

Permalink
doc: correct mismatch between template and readmes and trim trailing …
Browse files Browse the repository at this point in the history
…white space
  • Loading branch information
the-forest-tree authored and the-forest-tree committed Jul 1, 2024
1 parent 1a75e2e commit 4f988f6
Show file tree
Hide file tree
Showing 14 changed files with 88 additions and 89 deletions.
10 changes: 5 additions & 5 deletions src/hrflow_connectors/connectors/adzuna/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- [🔌 Connector Actions](#-connector-actions)
- [🐍 Quick Start Example](#-quick-start-example)
- [🔗 Useful Links](#-useful-links)
- [🙏 Special Thanks](#-special-thanks)
- [👏 Special Thanks](#-special-thanks)


# 📝 About Adzuna
Expand All @@ -19,7 +19,7 @@ Adzuna is a smarter, more transparent job search engine that helps you dodge the
</p>


# 📊 Data Flow
# 📊 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

Expand Down Expand Up @@ -51,9 +51,9 @@ To browse the examples of actions corresponding to released versions of 🤗 thi
<image src=https://user-images.githubusercontent.com/57711045/215874507-a36933f2-af97-4ee1-83d4-1d08eeebe06b.png width=90% height=100% >
</p>

Once the connector module is imported, you can leverage all the different actions that it offers.
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
Expand All @@ -63,7 +63,7 @@ For more code details checkout connector code
- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/adzuna) on our Github.


# 🙏 Special Thanks
# 👏 Special Thanks
- 💻 HrFlow.ai : [Nedhir Ebnou](https://github.com/nedhirouebnou) - Software Engineer


Expand Down
4 changes: 2 additions & 2 deletions src/hrflow_connectors/connectors/breezyhr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- [**Push Profiles Action**](#push-profiles-action)
- [**Pull Jobs Action**](#pull-jobs-action)
- [🔗 Useful Links](#-useful-links)
- [🙏 Special Thanks](#-special-thanks)
- [👏 Special Thanks](#-special-thanks)


# 📝 About BreezyHR
Expand Down Expand Up @@ -62,7 +62,7 @@ For more code details checkout connector code
- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/breezyhr) on our Github.


# 🙏 Special Thanks
# 👏 Special Thanks
- 💻 HrFlow.ai : [Limam VADHEL](https://github.com/limamvadhel) - Software Engineer
- 💻 HrFlow.ai : [Leo FERRETTI](https://github.com/Sprenger07) - Software Engineer
- 💻 HrFlow.ai :[Corentin DUCHENE](https://github.com/CorentinDuchene) - Software Engineer
Expand Down
12 changes: 6 additions & 6 deletions src/hrflow_connectors/connectors/bullhorn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
- [🔌 Connector Actions](#-connector-actions)
- [🐍 Quick Start Examples](#-quick-start-examples)
- [🔗 Useful Links](#-useful-links)
- [🙏 Special Thanks](#-special-thanks)
- [👏 Special Thanks](#-special-thanks)


# 💼 About Bullhorn
Expand Down Expand Up @@ -64,7 +64,7 @@ This new connector will enable:

# 🐍 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 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 :
Expand All @@ -74,9 +74,9 @@ To browse the examples of actions corresponding to released versions of 🤗 thi
</p>


Once the connector module is imported, you can leverage all the different actions that it offers.
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
Expand All @@ -85,7 +85,7 @@ For more code details checkout connector code
- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/bullhorn) on our Github.


# 🙏 Special Thanks
# 👏 Special Thanks
- 💻 HrFlow.ai : [Daniel ROSA](https://github.com/DanielRosa73) - Software Engineer
- 🤝 Bullhorn : Arne LOOTEN - Partner Manager
- 🤝 Bullhorn : Arne LOOTEN - Partner Manager

12 changes: 6 additions & 6 deletions src/hrflow_connectors/connectors/ceridian/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@
- [🔌 Connector Actions](#-connector-actions)
- [🐍 Quick Start Examples](#-quick-start-examples)
- [🔗 Useful Links](#-useful-links)
- [🙏 Special Thanks](#-special-thanks)
- [👏 Special Thanks](#-special-thanks)


# 📝 About Ceridian
# 📝 About Ceridian

Cloud HCM software that brings together real-time payroll, HR, benefits, time reporting, talent and workforce management to empower your people.

<p align="center">
<image src=https://user-images.githubusercontent.com/46778695/213708839-35e09e59-8535-423b-bd01-55c37b5fbddd.png width=90% height=100% >
</p>

# 📊 Data Flow
# 📊 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

<p align="center">
Expand Down Expand Up @@ -46,9 +46,9 @@ To browse the examples of actions corresponding to released versions of 🤗 thi
<image src=https://user-images.githubusercontent.com/107410704/219010630-f7f92608-48a9-43ce-95fb-2157a436b3cd.png width=90% height=100% >
</p>

Once the connector module is imported, you can leverage all the different actions that it offers.
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
Expand All @@ -58,7 +58,7 @@ For more code details checkout connector code
- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/ceridian) on our Github.


# 🙏 Special Thanks
# 👏 Special Thanks
- 💻 HrFlow.ai: [Daniel ROSA](https://github.com/DanielRosa73) - Software Engineer
- 💻 HrFlow.ai: [Limam VADHEL](https://github.com/limamvadhel) - Software Engineer
- 💻 HrFlow.ai: [Corentin DUCHENE](https://github.com/CorentinDuchene) - Software Engineer
Expand Down
12 changes: 6 additions & 6 deletions src/hrflow_connectors/connectors/greenhouse/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
- [🔌 Connector Actions](#-connector-actions)
- [🐍 Quick Start Examples](#-quick-start-examples)
- [🔗 Useful Links](#-useful-links)
- [🙏 Special Thanks](#-special-thanks)
- [👏 Special Thanks](#-special-thanks)


# 📝 About Greenhouse
# 📝 About Greenhouse

Greenhouse is an applicant tracking system and recruitment software that helps companies manage and streamline their hiring process. It includes features such as job posting, candidate tracking, scheduling interviews, and offer management. Greenhouse also provides analytics and reporting to help companies track the effectiveness of their recruitment process. It also offers an API to help companies integrating it with other internal systems.

Expand All @@ -19,7 +19,7 @@ Greenhouse is an applicant tracking system and recruitment software that helps c
width=90% height=100% >
</p>

# 📊 Data Flow
# 📊 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

![image](https://user-images.githubusercontent.com/113343504/215127610-4936bffa-3262-4e72-942b-43ba22dd2ccd.png)
Expand Down Expand Up @@ -48,9 +48,9 @@ To browse the examples of actions corresponding to released versions of 🤗 thi
<image src=https://user-images.githubusercontent.com/107410704/219013506-7fb78971-ee1e-4374-8d89-6956034093c3.png width=90% height=100% >
</p>

Once the connector module is imported, you can leverage all the different actions that it offers.
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
Expand All @@ -60,7 +60,7 @@ For more code details checkout connector code
- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/greenhouse) on our Github.


# 🙏 Special Thanks
# 👏 Special Thanks
- 💻 HrFlow.ai: [Arthur STIEVENARD](https://github.com/arthurstiev) - Software Engineer
- 💻 HrFlow.ai: [Limam VADHEL](https://github.com/limamvadhel) - Software Engineer
- 💻 HrFlow.ai: [Clement NEGRE](https://github.com/ClemNeg0) - Software Engineer
Expand Down
10 changes: 5 additions & 5 deletions src/hrflow_connectors/connectors/hubspot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- [🔌 Connector Actions](#-connector-actions)
- [🐍 Quick Start Example](#-quick-start-example)
- [🔗 Useful Links](#-useful-links)
- [🙏 Special Thanks](#-special-thanks)
- [👏 Special Thanks](#-special-thanks)


# 📝 About Hubspot
Expand All @@ -18,7 +18,7 @@ HubSpot is a CRM platform with all the software, integrations, and resources you
</p>


# 📊 Data Flow
# 📊 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

<p align="center">
Expand Down Expand Up @@ -51,9 +51,9 @@ To browse the examples of actions corresponding to released versions of 🤗 thi
<image src=https://user-images.githubusercontent.com/107410704/219017227-8e7f86a6-fd8d-4e31-ab07-5ef13184eab0.png width=90% height=100% >
</p>

Once the connector module is imported, you can leverage all the different actions that it offers.
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
Expand All @@ -63,7 +63,7 @@ For more code details checkout connector code
- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/hubspot) on our Github.


# 🙏 Special Thanks
# 👏 Special Thanks
- 💻 HrFlow.ai : [Nedhir Ebnou](https://github.com/nedhirouebnou) - Software Engineer
- 🤝 Hubspot :[Hubspot for the accessible documentation](https://www.hubspot.com)

20 changes: 10 additions & 10 deletions src/hrflow_connectors/connectors/recruitee/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
- [🔌 Connector Actions](#-connector-actions)
- [🐍 Quick Start Examples](#-quick-start-examples)
- [🔗 Useful Links](#-useful-links)
- [🙏 Special Thanks](#-special-thanks)
- [👏 Special Thanks](#-special-thanks)

# 💼 About Recruitee
# 💼 About Recruitee

Recruitee is an innovative and intuitive recruitment software that empowers businesses to streamline hiring processes and attract top talent.

Expand All @@ -23,17 +23,17 @@ Recruitee provides a comprehensive solution that ensures a seamless and efficien

This new connector will enable Recruitee customers & partners to:
- ⚡ Seamlessly Integrate Talent & Workforce data
- 🤖 Elevate their Talent and Recruiter Experiences
- 🤖 Elevate their Talent and Recruiter Experiences

# 🔧 How does it work?

## 📊 Data integration capabilities:

- ➡️ Push Profiles from a Source of your choice to Recruitee
- ⬅️ Pull Jobs from Recruitee to a Destination of your choice

## 🧠 Artificial Intelligence capabilities:

- Easily Extract, Structure, and Categorize Talent & Workforce data
- Effortlessly Search, Score, and Match Profiles and Jobs with precision.

Expand Down Expand Up @@ -64,9 +64,9 @@ To browse the examples of actions corresponding to released versions of 🤗 thi
<image src=https://github.com/Riminder/hrflow-connectors/assets/57711045/44360e84-ec0c-49a1-81dd-799840613c6a width=90% height=100% >
</p>

Once the connector module is imported, you can leverage all the different actions that it offers.
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

Expand All @@ -75,7 +75,7 @@ For more code details checkout connector code
- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/recruitee) on our Github.


# 🙏 Special Thanks
# 👏 Special Thanks
- 💻 HrFlow.ai : [Nedhir EBNOU](https://github.com/nedhirouebnou) - Software Engineer
- 🤝 Recruitee : **MengJia de Lange-Chen - Technical Partner Manager** and all the Recruitee team for their help and collaboration in building this integration

24 changes: 12 additions & 12 deletions src/hrflow_connectors/connectors/salesforce/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
- [👍 Special Thanks](#-special-thanks)


# 📝 About Salesforce
# 📝 About Salesforce

Salesforce, Inc. is an American cloud-based software company headquartered in San Francisco, California. It provides customer relationship management (CRM) software and applications focused on sales, customer service, marketing automation, e-commerce, analytics, and application development.

Expand All @@ -21,8 +21,8 @@ Salesforce, Inc. is an American cloud-based software company headquartered in Sa

# Prerequesit

In order to leverage the Salesforce connector you need to perform initial setup of HrFlow tables in your Salesforce integration.
The code below uses Salesforce API to create the following Salesforce Custom Objects:
In order to leverage the Salesforce connector you need to perform initial setup of HrFlow tables in your Salesforce integration.
The code below uses Salesforce API to create the following Salesforce Custom Objects:
- `Hrflow_Job__c`
- `Hrflow_Profile__c`
- `Hrflow_Experience__c`
Expand All @@ -31,10 +31,10 @@ The code below uses Salesforce API to create the following Salesforce Custom Obj

> 💡 _Before running the code you can review all details about the Custom Objects in this [JSON](./hrflow_custom_objects.json) file_
In order to run code below you need:
In order to run code below you need:
- API Access enabled for your organization. Check this [link](https://help.salesforce.com/s/articleView?id=000385436&type=1) to see if it is supported by your Salesforce Edition
- A Salesforce user with API Enabled permission and enough privileges to create Custom Objects
- Install the [simple-salesforce](https://github.com/simple-salesforce/simple-salesforce) Python package
- Install the [simple-salesforce](https://github.com/simple-salesforce/simple-salesforce) Python package
```python
import json

Expand All @@ -45,10 +45,10 @@ HRFLOW_CUSTOM_OBJECTS_PATH = "./hrflow_custom_objects.json"
# Salesforce credentials
username = "==============FILL==ME=============="
password = "==============FILL==ME=============="
# How Can I Find My Security Token and Use It in Data Loader | Salesforce Platform
# How Can I Find My Security Token and Use It in Data Loader | Salesforce Platform
# https://www.youtube.com/watch?v=nYbfxeSGKFM&ab_channel=SalesforceSupport
security_token = "==============FILL==ME=============="
# Find your Salesforce Organization ID
# Find your Salesforce Organization ID
# https://help.salesforce.com/s/articleView?id=000385215&type=1
organization_id = "==============FILL==ME=============="

Expand Down Expand Up @@ -79,7 +79,7 @@ for custom_object in hrflow_custom_objects:
```

## How to create list view of HrFlow Custom Objects
Once logged to your Salesforce environment go to Setup then click Create > Custom Tab. Once created you should be able to view the list of records in each of the tables.
Once logged to your Salesforce environment go to Setup then click Create > Custom Tab. Once created you should be able to view the list of records in each of the tables.

<image width="1919" alt="HrFlow Jobs" src="https://github.com/Riminder/hrflow-connectors/assets/65894619/f20f62fd-e370-4e7f-8b85-0c4c2d4e43d1">
<image width="1919" alt="HrFlow Profiles" src="https://github.com/Riminder/hrflow-connectors/assets/65894619/828f25f5-a3da-4a4f-bcbb-56d6f75c3304">
Expand All @@ -90,7 +90,7 @@ Once logged to your Salesforce environment go to Setup then click Create > Custo
## Hrflow.ai Recruiter Copilot Widget installed in Salesforce
<image width="1919" alt="Scoring" src="https://github.com/Riminder/hrflow-connectors/assets/135601200/2434d21a-1994-4e16-a6b0-65d7e2a6fa49">

# 📊 Data Flow
# 📊 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

<p align="center">
Expand Down Expand Up @@ -120,9 +120,9 @@ To browse the examples of actions corresponding to released versions of 🤗 thi
<image src=https://github.com/Riminder/hrflow-connectors/assets/65894619/2ee70c18-e557-4b6b-8b2b-ea2243d58c1b width=90% height=100% >
</p>

Once the connector module is imported, you can leverage all the different actions that it offers.
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

Expand All @@ -131,6 +131,6 @@ For more code details checkout connector code
- 💻 [Connector code](https://github.com/Riminder/hrflow-connectors/tree/master/src/hrflow_connectors/connectors/salesforce) on our Github.


# 👍 Special Thanks
# 👍 Special Thanks
- 💻 HrFlow.ai : [the-forest-tree](https://github.com/the-forest-tree) - Software Engineer
- 🤝 Salesforce : [Salesforce Developer Centers](https://developer.salesforce.com/)
Loading

0 comments on commit 4f988f6

Please sign in to comment.