GitBook Airdrop
Seamlessly import your articles from GitBook to DevRev.
Supported objects
The following is a list of GitBook objects and their corresponding DevRev equivalent. Those marked as Supported are eligible for import.
Import from GitBook
Follow the steps below to import from GitBook:
-
In Marketplace, search for GitBook under the Import category and select the option for the GitBook.
-
In the snap-in config modal, click Install then go to Integrations > Imports in your settings left nav.
-
Click the Import button and select the GitBook tile in the Start import window.
-
Create a new connection to your GitBook account, or use an existing. connection if you already have one.
While creating the connection, you are required to input a Subdomain field. This is a mandatory unique identifier used by Airdrop to group together imports from the same source system.
It is recommended to use the name of the GitBook workspace you want to import as the value of Subdomain.
-
Once the connection is established, select the GitBook workspace you want to import, and specify the DevRev part that should be used for any imported work. This initiates a bulk import of the selected site.
-
Click Map fields in the import row and configure filters, object mapping, or field mapping as necessary.
While DevRev attempts to automatically map fields, you may be prompted to manually map indicated fields.
The duration of the import depends on the size of the GitBook workspace and the amount of data being imported. For a workspace with only a few dozen items, it can take seconds, while a workspace with tens of thousands of items may take a few hours. DevRev respects GitBook API rate limits and automatically handles back-off and resume.
Post-import options
After a successful import, you have the following options available for the imported workspace:
- Sync to DevRev
- Synchronize any modifications made in your GitBook workspace with the corresponding items previously imported into DevRev. It also creates new items in DevRev for any new supported object type in GitBook after the last sync or import.
- Periodic Sync
- Synchronize new changes from GitBook to DevRev on a periodic basis. The default frequency is once an hour.
- View Report
- Access detailed information about the initial import and any subsequent syncs performed.
- Delete Import
- Remove the import and all items that were imported from GitBook into DevRev, you can use this option.
- Edit Connection
- Change the connection used for any subsequent actions. It can be helpful if a connection becomes inactive or the user who established it is no longer. available.
Historical imports
To view currently running and previous imports from various sources, including GitBook, follow these steps:
- Go to Settings > Integrations > Imports.
- Select the Import you want.
- Click on the context menu (3 dots), and select "View Report".
Sync to DevRev
After a successful import from a GitBook workspace, you can choose to sync the imported data with DevRev. This feature imports any new collections and articles and any changes made to previously imported items from GitBook.
To perform a one-time sync to DevRev, follow these steps:
- Go to Settings > Integrations > Imports.
- Locate the previously imported project.
- Select the ⇆ > ⇾ From Snap-ins to DevRev option.
A one-time sync may override fields in previously imported items, even if they were modified in DevRev.
Periodic sync
After successfully importing from a GitBook Workspace, you have the option to enable a periodic sync. This allows for automatic synchronization between GitBook and DevRev on a regular basis. By default, the sync occurs once an hour.
To configure periodic sync, follow these steps:
- Go to Settings > Integrations > Imports.
- Locate the previously imported project.
- Select the ⇆ > Set Periodic Sync option.
The Enable automations for synced items setting is optional and can be activated during periodic sync configuration. When enabled, newly created or updated items trigger events, which can initiate webhooks, notifications, Snap-ins, and other processes, as if the events originated directly in DevRev.
If this setting is disabled, updates do not trigger any event-driven processes. This behavior applies only to periodic syncs; no events are triggered during a first-time import or manual sync to or from DevRev.
Delete import
An import and all the content it creates can be deleted from DevRev. This can be useful when running POCs or to change the recipe used during the import. Once an import has been deleted, all the content it created gets deleted, even if they were modified in DevRev. It's possible to import the project again after its deletion.
:::warn Deleting the import deletes any content created by the import, including tags, collections, and articles.:::
To delete an import and all the content it created, go to Settings > Integrations > Imports, find the previously imported project, and select ⋮ > Delete Import.
