@@ -15,7 +15,7 @@ You may find the adapter you are interested in contributing already exists in on
## Step 1 - Verify the Need
Before contributing a new adapter, be sure you have verified there is a need for one.
* Review existing adapters in the category groups above and verify the adapter doesn't already exist
* Review existing adapters in the category groups above and verify the adapter doesn't already exist.
* Adapters may fall into multiple categories, you must all of the adapter categories.
* Adapter Builder should inform you if the adapter you are building already exists.
...
...
@@ -31,32 +31,32 @@ Before contributing a new adapter, be sure you have verified there is a need for
## Step 2 - Create an Adapter
Get an OpenApi 3.0 document for the system you want to integrate with
You may be able to get this from the Vendor website or from a contact with the Vendor
You may have to convert a WSDL or a Postman Collection to an OpenAPI document using something like APImatic
Build the new adapter using the [Itential Adapter Builder](https://adapters.itential.io)
Install the generated adapter into your IAP environment
1.Get an OpenApi 3.0 document for the system you want to integrate with
*You may be able to get this from the Vendor website or from contact with the Vendor.
*You may have to convert a WSDL or a Postman Collection to an OpenAPI document using something like APImatic.
2.Build the new adapter using the [Itential Adapter Builder](https://adapters.itential.io).
3.Install the generated adapter into your IAP environment.
## Step 3 - GitLab Project Creation
1. Determine what category the new adapter should be in
1. Go into the GitLab category group folder for the new adapter (links above)
1. Determine what category the new adapter should be in.
1. Go into the GitLab category group folder for the new adapter. (links above)
If you do not have permissions to create a project within the Itential Adapter Opensource project you will need to submit an Itential Service Desk (ISD) or an Adapter Team (ADAPT) ticket. Make sure to include the name and category for the adapter.
If you have permissions within the Itential Adapter Opensource project you can follow this process:
1. Click the _New project_ button
1. Choose _Create Blank Project_
1. For the project name put adapter-vendor_system (e.g. adapter-amazon_abcd). If the vendor and system are the same you will not need _system. If the system name is many words, you can separate words with the _
1. Uncheck the option to initialize the project with a README - that will come from your adapter
1. Make sure to leave the project **private**, it will not be public until it is reviewed by the Adapter Team
1. Click the _Create project_ button
1. Click the _New project_ button.
1. Choose _Create Blank Project_ button.
1. For the project name put adapter-vendor_system (e.g. adapter-amazon_abcd). If the vendor and system are the same you will not need _system. If the system name is many words, you can separate words with the _.
1. Uncheck the option to initialize the project with a README - that will come from your adapter.
1. Make sure to leave the project **private**, it will not be public until it is reviewed by the Adapter Team.
1. Click the _Create project_ button.
## Step 4 - Upload the Adapter to GitLab
This assumes you have installed git in your local environment.
The Adapters use a **_master_** branch and not a main branch so please follow these instructions
The Adapters use a **_master_** branch and not the main branch so please follow these instructions
In your environment
1. cd existing_folder where you installed the adapter
