Skip to content

Commit 34426f9

Browse files
authored
docs: reorganize integrations sidebar (#1042)
add new sub categories - Programming - Actor-to-Actor - Workflows & notifications - Data storage - AI add _category_.yml to each new folder to control sidebar label and position fix all the md links to account for new structure
1 parent b06c7a7 commit 34426f9

File tree

34 files changed

+161
-139
lines changed

34 files changed

+161
-139
lines changed

sources/platform/actors/development/actor_definition/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Actors have the following elements:
2323

2424
The documentation and the input/output schemas make it possible for people to easily understand what the Actor does, enter the required inputs both in the user interface or API, and integrate the Actor's results with their other workflows. Actors can easily call and interact with each other, enabling building more complex systems on top of simple ones.
2525

26-
The Apify platform provides an open [API](/api/v2), cron-style [scheduler](../../schedules), [webhooks](../../../integrations/webhooks/index.md), and [integrations](../../integrations) to services such as Zapier or Make, which make it easy for users to integrate Actors with their existing workflows. Anyone is welcome to [publish Actors](/platform/actors/publishing) in [Apify Store](https://apify.com/store), and you can even [monetize your Actors](/platform/actors/publishing/monetize).
26+
The Apify platform provides an open [API](/api/v2), cron-style [scheduler](../../schedules), [webhooks](../../../integrations/programming/webhooks/index.md), and [integrations](../../integrations) to services such as Zapier or Make, which make it easy for users to integrate Actors with their existing workflows. Anyone is welcome to [publish Actors](/platform/actors/publishing) in [Apify Store](https://apify.com/store), and you can even [monetize your Actors](/platform/actors/publishing/monetize).
2727

28-
Actors can be developed and run locally and then easily deployed to the Apify platform using the [Apify CLI](/cli) or a [GitHub integration](../../../integrations/github.md). For more details, see the [Deployment](../deployment/index.md) section.
28+
Actors can be developed and run locally and then easily deployed to the Apify platform using the [Apify CLI](/cli) or a [GitHub integration](../../../integrations/programming/github.md). For more details, see the [Deployment](../deployment/index.md) section.
2929

3030
> **To get a better idea of what Apify Actors are, visit [Apify Store](https://apify.com/store), and try out some of them!**

sources/platform/actors/development/deployment/source_types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To specify a Git branch or tag to check out, add a URL fragment to the URL. For
3434

3535
Optionally, the second part of the fragment in the Git URL (separated by a colon) specifies the directory from which the Actor will be built (and where the `.actor`) folder is located. For example, `https://github.com/jancurn/some-actor.git#develop:some/dir` will check out the **develop** branch and set **some/dir** as the root directory of the Actor.
3636

37-
Note that you can easily set up an integration where the Actor is automatically rebuilt on every commit to the Git repository. For more details, see [GitHub integration](../../../integrations/github.md).
37+
Note that you can easily set up an integration where the Actor is automatically rebuilt on every commit to the Git repository. For more details, see [GitHub integration](../../../integrations/programming/github.md).
3838

3939
### [](#private-repositories)Private repositories
4040

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
position: 3

sources/platform/integrations/actors/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Actors
2+
title: Actor-to-Actor
33
description: Learn how to integrate with other Actors and tasks.
4-
sidebar_position: 11.10
4+
sidebar_label: Actor-to-Actor
55
slug: /integrations/actors
66
---
77

sources/platform/integrations/actors/integration_ready_actors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Integration-ready Actors
2+
title: Creating integration Actors
33
description: Learn how to create Actors that are ready to be integrated with other Actors and tasks.
44
sidebar_position: 1
55
slug: /integrations/actors/integration-ready-actors
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
label: 'AI'
2+
position: 6

sources/platform/integrations/flowise.md renamed to sources/platform/integrations/ai/flowise.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2-
title: Flowise
2+
title: Flowise integration
33
description: Learn how to integrate Apify with Flowise.
4-
sidebar_position: 11.20
4+
sidebar_label: Flowise
5+
sidebar_position: 3
56
slug: /integrations/flowise
67
---
78

@@ -43,23 +44,23 @@ The first step is to create a new flow in the web UI.
4344

4445
In the left menu, you need to find Apify Website Content Crawler under Document Loaders.
4546

46-
![Flowise add Apify Crawler](./images/flowise-apify.png)
47+
![Flowise add Apify Crawler](../images/flowise-apify.png)
4748

4849
Now you need to configure the crawler. You can find more information about the crawler [here](https://apify.com/apify/website-content-crawler).
4950

50-
![Flowise and Apify](images/flowise.png)
51+
![Flowise and Apify](../images/flowise.png)
5152

5253
In the configuration, provide your Apify API token, which you can find in your [Apify account](https://my.apify.com/account#/integrations).
5354

54-
![Apify API token screen](./images/flowise-apify-api.png)
55+
![Apify API token screen].(./images/flowise-apify-api.png)
5556

5657
You can add more loaders, or you can add some processors to process the data.
5758
In our case, we create the flow that loads data from the Apify docs using Website Content Crawler and save them into the in-memory vector database.
5859
Connect the ChatOpenAI and the OpenAI embeddings and QA retrieval into the chatbot.
5960

6061
The final flow can answer questions about Apify docs.
6162

62-
![Flowise and Apify](images/flowise-2.png)
63+
![Flowise and Apify](../images/flowise-2.png)
6364

6465
For more information visit the Flowise [documentation](https://flowiseai.com/).
6566

sources/platform/integrations/langchain.md renamed to sources/platform/integrations/ai/langchain.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: 🦜🔗 LangChain
2+
title: 🦜🔗 LangChain integration
33
sidebar_label: LangChain
44
description: Learn how to integrate Apify with 🦜🔗 LangChain, in order to feed vector databases and LLMs with data crawled from the web.
5-
sidebar_position: 11.19
5+
sidebar_position: 1
66
slug: /integrations/langchain
77
---
88

sources/platform/integrations/llama.md renamed to sources/platform/integrations/ai/llama.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2-
title: LlamaIndex
2+
title: LlamaIndex integration
33
description: Learn how to integrate Apify with LlamaIndex in order to feed vector databases and LLMs with data crawled from the web.
4-
sidebar_position: 11.21
4+
sidebar_label: Llamaindex
5+
sidebar_position: 2
56
slug: /integrations/llama
67
---
78

sources/platform/integrations/pinecone.md renamed to sources/platform/integrations/ai/pinecone.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2-
title: Pinecone
2+
title: Pinecone integration
33
description: Learn how to integrate Apify with Pinecone to feed data crawled from the web into the Pinecone vector database.
4-
sidebar_position: 11.22
4+
sidebar_label: Pinecone
5+
sidebar_position: 4
56
slug: /integrations/pinecone
67
toc_min_heading_level: 2
78
toc_max_heading_level: 4
@@ -41,11 +42,11 @@ The examples utilize the Website Content Crawler Actor, which deeply crawls webs
4142

4243
1. Once you have the crawler ready, navigate to the integration section and add Apify’s Pinecone integration.
4344

44-
![Website Content Crawler with Pinecone integration](./images/pinecone-wcc-integration.png)
45+
![Website Content Crawler with Pinecone integration](../images/pinecone-wcc-integration.png)
4546

4647
1. Select when to trigger this integration (typically when a run succeeds) and fill in all the required fields for the Pinecone integration. You can learn more about the input parameters at the [Pinecone integration input schema](https://apify.com/jan.turon/pinecone-integration/input-schema).
4748

48-
![Pinecone integration configuration](./images/pinecone-integration-setup.png)
49+
![Pinecone integration configuration](../images/pinecone-integration-setup.png)
4950

5051
1. For a comprehensive explanation on how to combine Actors to accomplish more complex tasks, refer to the guide on [Actor-to-Actor](https://blog.apify.com/connecting-scrapers-apify-integration/) integrations.
5152

0 commit comments

Comments
 (0)