Skip to content

Commit c0f6784

Browse files
bhavikchavdagitbook-bot
bhavikchavda
authored andcommitted
GITBOOK-87: Manage Project
1 parent 199fbea commit c0f6784

35 files changed

+80
-103
lines changed

.gitbook/assets/image (83).png

20.6 KB
Loading

.gitbook/assets/image (84).png

248 KB
Loading

.gitbook/assets/image (85).png

24.7 KB
Loading

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2+
icon: wreath
23
description: >-
34
Impler is open-source data import infrastructure, built for engineering teams
45
to help them build rich data import experience without constantly reinventing
56
the wheel.
6-
icon: wreath
77
---
88

99
# Introduction
@@ -24,4 +24,4 @@ As developers, we tend to care about the performance of the application, but fol
2424

2525
One of the reasons for making Impler open-source was to ensure privacy and give back to the community. We heard from many teams and we also felt `How hard it's to give support for Data import functionality`. So to make it accessible to everyone, we decided to build the Impler with awesome people like you.
2626

27-
We welcome and appreciate everyone's suggestions and improvements, join us on [Discord](https://discord.impler.io) and [GitHub](https://github.com/knovator/impler.io).
27+
{% include ".gitbook/includes/your-feedback-is-crucial-in....md" %}

SUMMARY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@
3737
* [Freeze Columns](features/freeze-columns.md)
3838
* [Multiselect Dropdown](features/multiselect-dropdown.md)
3939
* [Output Customization](features/output-customization.md)
40-
* [Make Your Team](features/make-your-team.md)
4140

4241
## Platform
4342

4443
* [Email Alerts](platform/email-alerts.md)
4544
* [Activity Page](platform/activity-page.md)
4645
* [Manage Project](platform/manage-project.md)
46+
* [Make Your Team](platform/make-your-team.md)
4747
* [How subscription works?](platform/how-subscription-works.md)
4848

4949
## Additional Resources

additional-resources/architecture.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2+
icon: sitemap
23
description: >-
34
Guide on various building blocks of Impler, How they communicate and How
45
Impler works?
5-
icon: sitemap
66
---
77

88
# Architecture
@@ -34,3 +34,5 @@ API keys are used to authenticate APIs happening from import widget. Additionall
3434
### SDKs
3535

3636
SDKs removes the need of managing import widget manually. In case of missing SDK developer can take reference of [html-js-embed.md](../importer/html-js-embed.md "mention")to embed widget into application.
37+
38+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

additional-resources/data-migrations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ Below you will find a list of migrations introduced in previous versions of Impl
2828

2929
<table><thead><tr><th width="126">Version</th><th width="235">Feature</th><th>Migration Path(s)</th></tr></thead><tbody><tr><td><a href="https://github.com/implerhq/impler.io/releases/tag/v0.16.0"><code>v0.16.0</code></a></td><td>Date format consideration</td><td><code>./src/update-date-formats/update-date-formats.migration.ts</code></td></tr><tr><td><a href="https://changelog.impler.io/february-2024/v0.17.0-select-sheet-modal-add-column-improvements-and-column-ordering-facility"><code>0.17.0</code></a></td><td>Revision of template files according to new structure</td><td><code>./src/migrations/regenerate-templates/regenerate-templates.migration.ts</code></td></tr><tr><td><code>0.24.0</code></td><td>Verify user email using verification code</td><td><code>./src/migrations/verify-user/verify-user.migration.ts</code></td></tr><tr><td><code>0.27.0</code></td><td>Migrate users for teams support</td><td><code>./src/migrations/shift-environment-key/shift-environment-key.migration.ts</code></td></tr></tbody></table>
3030

31-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
31+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

additional-resources/faqs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
description: Find answers to most common questions our users have while using Impler
32
icon: comments-question-check
3+
description: Find answers to most common questions our users have while using Impler
44
---
55

66
# FAQs
@@ -49,4 +49,4 @@ API will send a file with headers `Content-Type` and `Content-Disposition` as va
4949

5050
</details>
5151

52-
Still, have any doubts? Please shoot us a message directly on [Discord](https://discord.impler.io).
52+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

additional-resources/run-impler-locally.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
description: What do you need to run Impler locally and how to perform the setup?
32
icon: computer
3+
description: What do you need to run Impler locally and how to perform the setup?
44
---
55

66
# Run Impler locally
@@ -136,4 +136,4 @@ npm run test:api
136136

137137
## [Running Migrations](run-impler-locally.md#running-migrations)
138138

139-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
139+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

additional-resources/writing-effectively-into-.xlsm-files.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2+
icon: file-spreadsheet
23
description: >-
34
Step-by-step guide showing how you and your users can handle .xlsm file
45
constraints, while editing into it.
5-
icon: file-spreadsheet
66
---
77

88
# Writing effectively into .xlsm files
@@ -66,6 +66,6 @@ By following these steps, you can effectively use the Multiselect feature in `.x
6666
#### Linux:
6767

6868
* Open the `.xlsm` file in LibreOffice Calc.
69-
* Manually type the options in multiselect fields.
69+
* Manually type the options in multi-select fields.
7070

71-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
71+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

data-retrieval/using-frontend-callback.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2+
icon: globe-pointer
23
description: >-
34
Get sanitized and formatted user-imported data Directly on your frontend
45
application. Helping you to access data directly.
5-
icon: globe-pointer
66
---
77

88
# Using Frontend Callback
@@ -26,4 +26,4 @@ Once the destination is enabled Impler will start sending Imported data on the f
2626

2727
To access we can use `onDataImported` method at [#listening-for-events](../importer/react-embed.md#listening-for-events "mention") if using react or can check for a`DATA_IMPORTED` event as per [#listening-to-events](../importer/html-js-embed.md#listening-to-events "mention") if using HTML & JavaScript.
2828

29-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
29+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

data-retrieval/using-webhook.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
description: Get data right into the application whenever the user imports the file
32
icon: webhook
3+
description: Get data right into the application whenever the user imports the file
44
---
55

66
# Using Webhook
@@ -31,4 +31,4 @@ Details to provide `Auth Header Value` is available at [#providing-authenticatio
3131

3232
<table data-full-width="false"><thead><tr><th width="217.33333333333337">Name</th><th width="487">Description</th></tr></thead><tbody><tr><td>template</td><td><code>CODE</code> of the template</td></tr><tr><td>uploadId</td><td>Upload ID</td></tr><tr><td>data</td><td>Array of data in JSON format</td></tr><tr><td>totalRecords</td><td>Total number of records in uploaded spreadsheet</td></tr><tr><td>totalPages</td><td>Total number of pages the data is divided on</td></tr><tr><td>page</td><td>Current page number</td></tr><tr><td>pageSize</td><td>Size of the data being sent</td></tr><tr><td>extra</td><td>Extra string or JSON if it's being passed to <code>Import</code> button</td></tr></tbody></table>
3333

34-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
34+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

features/automated-import.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,4 @@ externalUserId/:jobId' \
9393
--header 'accesskey: <ACCESS_TOKEN>'
9494
```
9595

96-
***
97-
98-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
96+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

features/column-description.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2+
icon: message-lines
23
description: >-
34
Add description to your columns to help users understand what value to put
45
into column.
5-
icon: message-lines
66
---
77

88
# Column Description
@@ -31,6 +31,4 @@ It's possible to change border of tooltip by providing primaryColor while openin
3131

3232
<figure><img src="../.gitbook/assets/image (66).png" alt=""><figcaption><p>Showing column description to user</p></figcaption></figure>
3333

34-
***
35-
36-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
34+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

features/custom-validation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2+
icon: rectangle-terminal
23
description: >-
34
Write your own validation code, making it possible to perform complex checks,
45
such as validating data against external databases or APIs.
5-
icon: rectangle-terminal
66
---
77

88
# Custom Validation
@@ -136,4 +136,4 @@ With custom validation in Impler, you have the flexibility to implement intricat
136136

137137
This feature empowers you to customize your imports to meet your specific needs, making complex data imports more accessible and efficient.
138138

139-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
139+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

features/data-seeding.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2+
icon: table-cells
23
description: >-
34
Populate essential data fields in your Excel samples with Data Seeding.
45
Simplify data input by preloading records, allowing users to build upon or
56
modify data.
6-
icon: table-cells
77
---
88

99
# Data Seeding
@@ -56,4 +56,4 @@ With the Data Seeding feature in Impler, you can save time and effort by automat
5656

5757
This is particularly valuable when importing data with complex relationships, ensuring a smooth and efficient data import experience.
5858

59-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
59+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

features/default-value.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2+
icon: swap
23
description: >-
34
Default value facility empowers developers to specify fallback values for
45
empty or missing columns. This ensures data consistency and completeness while
56
receiving the data.
6-
icon: swap
77
---
88

99
# Default Value
@@ -61,4 +61,4 @@ const schema = {
6161

6262
The Default Value functionality provides flexibility and control to developers when importing data. Whether dealing with optional columns or handling empty values, this feature enhances the overall data import experience.
6363

64-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
64+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

features/freeze-columns.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2+
icon: sidebar
23
description: >-
34
Freeze columns in excel and editor to better view data while editing and
45
adding records
5-
icon: sidebar
66
---
77

88
# Freeze Columns
@@ -56,4 +56,4 @@ While importing data spreadsheet editor freezes two default `Checkbox` and `Sr.
5656

5757
<figure><img src="../.gitbook/assets/image (29).png" alt=""><figcaption><p>Freezing 2 default and 2 mentioned columns in editor</p></figcaption></figure>
5858

59-
Have any doubts? Please shoot us a message directly on [Discord](https://discord.impler.io).
59+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

features/import-excel-with-image.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2+
icon: images
23
description: >-
34
Impler allows importing data files with images. Image import is useful in
45
scenarios like Employee data with profile photos, Products with images, or
56
Assets with pictures.
6-
icon: images
77
---
88

99
# Import Excel with Image
@@ -75,6 +75,4 @@ curl --location --request GET 'https://api.impler.io/v1/upload/66b759d087a854c81
7575
```
7676
{% endcode %}
7777

78-
***
79-
80-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
78+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

features/multiselect-dropdown.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2+
icon: list-dropdown
23
description: >-
34
The Multiselect feature in Impler allows users to pick multiple values for a
45
single cell. This feature is useful in various scenarios like selecting
56
categories for products, tagging items, and more.
6-
icon: list-dropdown
77
---
88

99
# Multiselect Dropdown
@@ -63,4 +63,4 @@ For detailed steps on how to write in `.xlsm` files refer to [writing-effectivel
6363

6464
Columns with the Multiselect feature will send an array of selected values when sent to application [using-webhook.md](../data-retrieval/using-webhook.md "mention") or [using-frontend-callback.md](../data-retrieval/using-frontend-callback.md "mention").
6565

66-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
66+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

features/output-customization.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
description: Customize output format to receive data in a manner that the system can use.
32
icon: tree-christmas
3+
description: Customize output format to receive data in a manner that the system can use.
44
---
55

66
# Output Customization
@@ -83,4 +83,4 @@ In that case, we need to provide schema runtime. We have listed examples for rea
8383

8484
This output customization capability empowers you to direct imported data to any destination and in any preferred format.
8585

86-
Have any questions? Feel free to ping us over [discord](https://discord.impler.io).
86+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

features/runtime-schema.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2+
icon: eye-slash
23
description: >-
34
Do you need to import data in columns that are not fixed firsthand? Impler
45
provides a facility to provide schema at the moment of opening the import
56
widget.
6-
icon: eye-slash
77
---
88

99
# Runtime Schema
@@ -56,4 +56,4 @@ Here are the keys&#x20;
5656
* `regex (optional)`: A regular expression to override when the type is `regex`.
5757
* `dateFormats (optional)`: Date formats indicating a list of formats acceptable for the date field. Required when type is `Date`. For example, `['dd/mm/yyyy','dd/mm/yy']`
5858

59-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
59+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

importer/angular-embed.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,4 @@ public show(): void {
319319
}
320320
```
321321

322-
***
323-
324-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
322+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

importer/bubble.io-embed.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -137,4 +137,4 @@ Provide Primary Color in properties to change the color theme of Importer.
137137

138138
> In Progress
139139
140-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
140+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

importer/html-js-embed.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -360,4 +360,4 @@ window.impler.show({
360360
});
361361
```
362362

363-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
363+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

importer/react-embed.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,4 @@ const { showWidget, isImplerInitiated } = useImpler({
299299
});
300300
```
301301

302-
***
303-
304-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
302+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

importer/text-customization.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,4 @@ When doing manual import of data the most commonly used texts are mentioned belo
230230
}
231231
```
232232

233-
***
234-
235-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io)!
233+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

overview/how-to-use-it.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2+
icon: arrow-progress
23
description: >-
34
Leverage Impler capabilites to build rich, scalable and user friendly data
45
import experience
5-
icon: arrow-progress
66
---
77

88
# How to use it? In 5 steps
@@ -47,3 +47,5 @@ It's time to import your CSV or Excel file. We can do it in two ways:
4747
<figure><img src="../.gitbook/assets/image (4) (1) (1) (1).png" alt=""><figcaption><p>Embed Import widget into your application</p></figcaption></figure>
4848

4949
And that's it! With these five straightforward steps, you are well on your way to revolutionizing your data onboarding process and delivering an exceptional user experience.
50+
51+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

platform/activity-page.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
description: Your hub for tracking and understanding your import activity.
32
icon: chart-line-up-down
3+
description: Your hub for tracking and understanding your import activity.
44
---
55

66
# Activity Page
@@ -49,4 +49,4 @@ Whether you're seeking a quick overview or a comprehensive analysis, the Activit
4949

5050
Impler's Activity Page is designed to streamline your import tracking, optimize your workflow, and empower you with data-driven decision-making capabilities.
5151

52-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
52+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

platform/email-alerts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2+
icon: paper-plane
23
description: >-
34
Impler will send you alert mail for anything that goes wrong during importing
45
data
5-
icon: paper-plane
66
---
77

88
# Email Alerts
@@ -19,4 +19,4 @@ Here is the sample mail,
1919

2020
<figure><img src="../.gitbook/assets/image (43).png" alt=""><figcaption><p>Sample mail sent to user while validation code fails</p></figcaption></figure>
2121

22-
Have any doubts? Shoot us a message directly on [Discord](https://discord.impler.io).
22+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

platform/how-subscription-works.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2+
icon: subscript
23
description: >-
34
Get idea about how subscription works in impler. How pricing will be
45
calculated, payment gateway being used internally and how it will affect
56
usage.
6-
icon: subscript
77
---
88

99
# How subscription works?
@@ -20,4 +20,4 @@ Impler assigns every user the **Starter Plan**, which includes 5,000 free record
2020
* Plan upgrades take effect immediately. While Plan downgrades occur at the end of the current billing cycle.
2121
* Users can cancel their plan anytime. Upon cancellation, the canceled plan does not renew at the end of the billing cycle, and the default Starter Plan is reactivated. Outstanding amounts are deducted at the end of the billing cycle after cancellation.
2222

23-
At Impler, we do our best to ensure flexibility and convenience while maintaining a clear and fair billing structure. Have doubts? Feel free to shoot us an email at [bhavik@impler.io](mailto:bhavik@impler.io), in case you need any help.
23+
{% include "../.gitbook/includes/your-feedback-is-crucial-in....md" %}

0 commit comments

Comments
 (0)