Skip to content

Commit aa61870

Browse files
authored
UI/API: Further updates to getting-started notes at the beginning of connector how-to pages (#530)
1 parent 514601a commit aa61870

File tree

9 files changed

+45
-8
lines changed

9 files changed

+45
-8
lines changed

api-reference/workflow/destinations/overview.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Overview
33
---
44

5+
import FirstTimeAPIDestinationConnector from '/snippets/general-shared-text/first-time-api-destination-connector.mdx';
6+
7+
<FirstTimeAPIDestinationConnector />
8+
59
To use the [Unstructured Workflow Endpoint](/api-reference/workflow/overview) to manage destination connectors, do the following:
610

711
- To get a list of available destination connectors, use the `UnstructuredClient` object's `destinations.list_destinations` function (for the Python SDK) or

api-reference/workflow/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; pic
4242
allowfullscreen
4343
></iframe>
4444

45-
Watch the following 3-minute video to learn how to use the Python SDK to call the Unstructured Workflow Endpoint to
45+
Watch the following 4-minute video to learn how to use the Python SDK to call the Unstructured Workflow Endpoint to
4646
create [workflows](#workflows) and [jobs](#jobs) in the Unstructured UI.
4747

4848
<iframe

api-reference/workflow/sources/overview.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Overview
33
---
44

5+
import FirstTimeAPISourceConnector from '/snippets/general-shared-text/first-time-api-source-connector.mdx';
6+
7+
<FirstTimeAPISourceConnector />
8+
59
To use the [Unstructured Workflow Endpoint](/api-reference/workflow/overview) to manage source connectors, do the following:
610

711
- To get a list of available source connectors, use the `UnstructuredClient` object's `sources.list_sources` function (for the Python SDK) or

snippets/general-shared-text/first-time-api-destination-connector.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<Note>
22
If you're new to Unstructured, read this note first.
33

4-
Before you can create this destination connector, you must first [sign up for Unstructured](https://platform.unstructured.io) and get your
4+
Before you can create a destination connector, you must first [sign up for Unstructured](https://platform.unstructured.io) and get your
55
Unstructured API key. After you sign up, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to get the key.
66
To learn how, watch this 40-second [how-to video](https://www.youtube.com/watch?v=FucugLkYB6M).
77

@@ -12,6 +12,11 @@
1212
go directly to the [quickstart notebook](https://colab.research.google.com/drive/13f5C9WtUvIPjwJzxyOR3pNJ9K9vnF4ww),
1313
or watch the two 4-minute video tutorials for the [Unstructured Python SDK](/api-reference/workflow/overview#unstructured-python-sdk).
1414

15+
You can also create destination connectors with the Unstructured user interface (UI).
16+
[Learn how](/ui/destinations/overview).
17+
1518
If you need help, reach out to the [community](https://short.unstructured.io/pzw05l7) on Slack, or
1619
[contact us](https://unstructured.io/contact) directly.
20+
21+
You are now ready to start creating a destination connector! Keep reading to learn how.
1722
</Note>

snippets/general-shared-text/first-time-api-source-connector.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<Note>
22
If you're new to Unstructured, read this note first.
33

4-
Before you can create this source connector, you must first [sign up for Unstructured](https://platform.unstructured.io) and get your
4+
Before you can create a source connector, you must first [sign up for Unstructured](https://platform.unstructured.io) and get your
55
Unstructured API key. After you sign up, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to get the key.
66
To learn how, watch this 40-second [how-to video](https://www.youtube.com/watch?v=FucugLkYB6M).
77

@@ -12,6 +12,11 @@
1212
go directly to the [quickstart notebook](https://colab.research.google.com/drive/13f5C9WtUvIPjwJzxyOR3pNJ9K9vnF4ww),
1313
or watch the two 4-minute video tutorials for the [Unstructured Python SDK](/api-reference/workflow/overview#unstructured-python-sdk).
1414

15+
You can also create source connectors with the Unstructured user interface (UI).
16+
[Learn how](/ui/sources/overview).
17+
1518
If you need help, reach out to the [community](https://short.unstructured.io/pzw05l7) on Slack, or
1619
[contact us](https://unstructured.io/contact) directly.
20+
21+
You are now ready to start creating a source connector! Keep reading to learn how.
1722
</Note>
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
<Note>
22
If you're new to Unstructured, read this note first.
33

4-
Before you can create this destination connector, you must first [sign up for Unstructured](https://platform.unstructured.io).
4+
Before you can create a destination connector, you must first [sign up for Unstructured](https://platform.unstructured.io).
55
After you sign up, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to create the destination connector.
66

77
After you create the destination connector, add it along with a
88
[source connector](/ui/sources/overview) to a [workflow](/ui/workflows). Then run the worklow as a
99
[job](/ui/jobs). To learn how, try out the [hands-on UI quickstart](/ui/quickstart) or watch the 4-minute
1010
[video tutorial](https://www.youtube.com/watch?v=Wn2FfHT6H-o).
11+
12+
You can also create destination connectors with the Unstructured API.
13+
[Learn how](/api-reference/workflow/destinations/overview).
1114

1215
If you need help, reach out to the [community](https://short.unstructured.io/pzw05l7) on Slack, or
1316
[contact us](https://unstructured.io/contact) directly.
17+
18+
You are now ready to start creating a destination connector! Keep reading to learn how.
1419
</Note>
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
<Note>
22
If you're new to Unstructured, read this note first.
33

4-
Before you can create this source connector, you must first [sign up for Unstructured](https://platform.unstructured.io).
4+
Before you can create a source connector, you must first [sign up for Unstructured](https://platform.unstructured.io).
55
After you sign up, the [Unstructured user interface](/ui/overview) (UI) appears, which you use to create the source connector.
66

77
After you create the source connector, add it along with a
88
[destination connector](/ui/destinations/overview) to a [workflow](/ui/workflows). Then run the worklow as a
99
[job](/ui/jobs). To learn how, try out the [hands-on UI quickstart](/ui/quickstart) or watch the 4-minute
1010
[video tutorial](https://www.youtube.com/watch?v=Wn2FfHT6H-o).
11+
12+
You can also create source connectors with the Unstructured API.
13+
[Learn how](/api-reference/workflow/sources/overview).
1114

1215
If you need help, reach out to the [community](https://short.unstructured.io/pzw05l7) on Slack, or
1316
[contact us](https://unstructured.io/contact) directly.
17+
18+
You are now ready to start creating a source connector! Keep reading to learn how.
1419
</Note>

ui/destinations/overview.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
---
22
title: Overview
3-
description: Destination connectors in Unstructured are designed to specify the endpoint for data processed within the platform. These connectors ensure that the transformed and analyzed data is securely and efficiently transferred to a storage system for future use, often to a vector database for tasks that involve high-speed retrieval and advanced data analytics operations.
43
---
54

5+
import FirstTimeUIDestinationConnector from '/snippets/general-shared-text/first-time-ui-destination-connector.mdx';
6+
7+
<FirstTimeUIDestinationConnector />
8+
9+
Destination connectors in Unstructured are designed to specify the endpoint for data processed within the platform. These connectors ensure that the transformed and analyzed data is securely and efficiently transferred to a storage system for future use, often to a vector database for tasks that involve high-speed retrieval and advanced data analytics operations.
10+
611
![Destinations in the sidebar](/img/ui/Destinations-Sidebar.png)
712

813
To see your existing destination connectors, on the sidebar, click **Connectors**, and then click **Destinations**.

ui/sources/overview.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
---
22
title: Overview
3-
description: Source connectors are essential components in data integration systems that establish a link between your files and the data ingestion process. They facilitate the batch processing of files, allowing for the systematic retrieval and ingestion of data stored in various file formats.
4-
53
---
64

5+
import FirstTimeUISourceConnector from '/snippets/general-shared-text/first-time-ui-source-connector.mdx';
6+
7+
<FirstTimeUISourceConnector />
8+
9+
Source connectors are essential components in data integration systems that establish a link between your files and the data ingestion process. They facilitate the batch processing of files, allowing for the systematic retrieval and ingestion of data stored in various file formats.
10+
711
![Sources in the sidebar](/img/ui/Sources-Sidebar.png)
812

913
To see your existing source connectors, on the sidebar, click **Connectors**, and then click **Sources**.

0 commit comments

Comments
 (0)