Skip to content

Commit de9e141

Browse files
authored
Tie all of the quickstarts together (#733)
1 parent 22a8e1b commit de9e141

File tree

11 files changed

+49
-7
lines changed

11 files changed

+49
-7
lines changed

api-reference/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+
<Tip>
6+
To start using the Unstructured API right away, skip ahead to the [quickstart](/api-reference/partition/quickstart) now!
7+
</Tip>
8+
59
The Unstructured API consists of two parts:
610

711
- The [Unstructured Workflow Endpoint](/api-reference/workflow/overview) enables a full range of partitioning, chunking, embedding, and

api-reference/partition/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+
<Tip>
6+
To start using the Unstructured Partition Endpoint right away, skip ahead to the [quickstart](/api-reference/partition/quickstart) now!
7+
</Tip>
8+
59
The Unstructured Partition Endpoint, part of the [Unstructured API](/api-reference/overview), is intended for rapid prototyping of Unstructured's
610
various partitioning strategies, with limited support for chunking. It is designed to work only with processing of local files, one file
711
at a time. Use the [Unstructured Workflow Endpoint](/api-reference/workflow/overview) for production-level scenarios, file processing in

api-reference/partition/quickstart.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Unstructured API Quickstart
3+
sidebarTitle: Quickstart
34
---
45

56
<Tip>

api-reference/workflow/overview.mdx

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

5+
<Tip>
6+
To start using the Unstructured Workflow Endpoint right away, skip ahead to the [quickstart](#quickstart),
7+
which uses the Unstructured Python SDK from a remote hosted Google Colab notebook.
8+
</Tip>
9+
510
The [Unstructured UI](/ui/overview) features a no-code user interface for transforming your unstructured data into data that is ready
611
for retrieval-augmented generation (RAG).
712

docs.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
"group": "Sources",
4141
"pages": [
4242
"ui/sources/overview",
43+
"ui/sources/dropbox-source-quickstart",
4344
"ui/sources/azure-blob-storage",
4445
"ui/sources/box",
4546
"ui/sources/confluence",
@@ -67,6 +68,7 @@
6768
"group": "Destinations",
6869
"pages": [
6970
"ui/destinations/overview",
71+
"ui/destinations/pinecone-destination-quickstart",
7072
"ui/destinations/astradb",
7173
"ui/destinations/azure-ai-search",
7274
"ui/destinations/couchbase",
@@ -215,6 +217,7 @@
215217
"group": "Partition Endpoint",
216218
"pages": [
217219
"api-reference/partition/overview",
220+
"api-reference/partition/quickstart",
218221
"api-reference/partition/post-requests",
219222
"api-reference/partition/sdk-python",
220223
"api-reference/partition/sdk-jsts",

snippets/quickstarts/platform.mdx

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,20 @@ The following quickstart shows you how to use the Unstructured UI to process rem
33
The requirements are as follows.
44

55
- A compatible source (input) location that contains your data for Unstructured to process. [See the list of supported source types](/ui/connectors#sources).
6+
7+
If your source (input) location is not in this list, or if you do not yet have any source locations for Unstructured to process, **stop here** and
8+
skip over to the [Dropbox source connector quickstart](/ui/sources/dropbox-source-quickstart) instead. This quickstart
9+
guides you through the process of creating a free Dropbox account, uploading your files to Dropbox,
10+
and creating a source connector to connect Unstructured to those files.
11+
612
- For document-based source locations, compatible files in that location. [See the list of supported file types](/ui/supported-file-types). If you do not have any files available, you can download some from the [example-docs](https://github.com/Unstructured-IO/unstructured-ingest/tree/main/example-docs) folder in the Unstructured repo on GitHub.
713
- A compatible destination (output) location for Unstructured to put the processed data. [See the list of supported destination types](/ui/connectors#destinations).
814

15+
If your destination (output) location is not in this list, or if you do not yet have any destination locations for Unstructured to send its processed data, **stop here** and
16+
skip over to the [Pinecone destination connector quickstart](/ui/destinations/pinecone-destination-quickstart) instead. This quickstart
17+
guides you through the process of creating a free Pinecone account
18+
and creating a destination connector to connect Unstructured to a Pinecone dense serverless index within your Pinecone account.
19+
920
<iframe
1021
width="560"
1122
height="315"
@@ -26,7 +37,7 @@ import GetStartedSimpleUIOnly from '/snippets/general-shared-text/get-started-si
2637
![Sources in the sidebar](/img/ui/Sources-Sidebar.png)
2738
1. From your Unstructured dashboard, in the sidebar, click **Connectors**.
2839
2. Click **Sources**.
29-
3. Cick **New** or **Create Connector**.
40+
3. Click **New** or **Create Connector**.
3041
4. For **Name**, enter some unique name for this connector.
3142
5. In the **Provider** area, click the source location type that matches yours.
3243
6. Click **Continue**.
@@ -38,7 +49,7 @@ import GetStartedSimpleUIOnly from '/snippets/general-shared-text/get-started-si
3849
![Destinations in the sidebar](/img/ui/Destinations-Sidebar.png)
3950
1. In the sidebar, click **Connectors**.
4051
2. Click **Destinations**.
41-
3. Cick **New** or **Create Connector**.
52+
3. Click **New** or **Create Connector**.
4253
4. For **Name**, enter some unique name for this connector.
4354
5. In the **Provider** area, click the destination location type that matches yours.
4455
6. Click **Continue**.

ui/destinations/overview.mdx

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

5+
<Tip>
6+
If you do not have a destination location for Unstructured to send its processed data, skip over to the
7+
[Pinecone destination connector quickstart](/ui/destinations/pinecone-destination-quickstart). This quickstart
8+
guides you through the process of creating a free Pinecone account
9+
and creating a destination connector to connect Unstructured to a Pinecone dense serverless index within your Pinecone account.
10+
</Tip>
11+
512
import FirstTimeUIDestinationConnector from '/snippets/general-shared-text/first-time-ui-destination-connector.mdx';
613

714
<FirstTimeUIDestinationConnector />

ui/destinations/pinecone-destination-quickstart.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Pinecone destination connector quickstart
3+
sidebarTitle: Quickstart
34
---
45

56
Unstructured can connect to several types of [destinations](/ui/connectors#destinations). In this quickstart, you create a [Pinecone](https://www.pinecone.io) destination connector that you can add to your Unstructured [workflows](/ui/workflows).

ui/quickstart.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,9 @@ import GetStartedSimpleUIOnly from '/snippets/general-shared-text/get-started-si
2727
allowfullscreen
2828
></iframe>
2929

30-
Learn more about Unstructured [source connectors](/ui/sources/overview),
31-
[destination connectors](/ui/destinations/overview),
32-
[workflows](/ui/workflows),
33-
[jobs](/ui/jobs), and
34-
[managing your account](/ui/account/overview).
30+
4. To move beyond local file processing, you can try the following [remote quickstart](#remote-quickstart), or skip over to the [Dropbox source connector quickstart](/ui/sources/dropbox-source-quickstart) instead.
31+
32+
You can also learn about Unstructured [source connectors](/ui/sources/overview), [destination connectors](/ui/destinations/overview), [workflows](/ui/workflows), [jobs](/ui/jobs), and [managing your account](/ui/account/overview).
3533

3634
---
3735

ui/sources/dropbox-source-quickstart.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Dropbox source connector quickstart
3+
sidebarTitle: Quickstart
34
---
45

56
Unstructured can connect to several types of [sources](/ui/connectors#sources). In this quickstart, you create a [Dropbox](https://www.dropbox.com/) source connector that you can add to your Unstructured [workflows](/ui/workflows).

0 commit comments

Comments
 (0)