From 7635e1362e74f3faa8234cf60e6d2e78f4e6e7ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Wed, 27 Aug 2025 19:16:51 +0200 Subject: [PATCH 1/4] docs: remove H1 Remove redundant H1's Rephrase titles to match removed H1's Add sidebar_label key and match it with old titles --- .../development/actor_definition/dataset_schema/index.md | 5 ++--- .../actor_definition/input_schema/specification.md | 5 ++--- .../actor_definition/key_value_store_schema/index.md | 2 -- sources/platform/actors/development/automated_tests.md | 5 ++--- .../actors/development/builds_and_runs/state_persistence.md | 2 -- .../actors/development/deployment/continuous_integration.md | 2 -- .../programming_interface/environment_variables.md | 5 ++--- .../development/programming_interface/system_events.md | 5 ++--- sources/platform/actors/running/usage_and_resources.md | 2 -- sources/platform/collaboration/list_of_permissions.md | 2 -- .../collaboration/organization_account/how_to_use.md | 5 ++--- sources/platform/collaboration/organization_account/index.md | 2 -- sources/platform/collaboration/organization_account/setup.md | 2 -- sources/platform/integrations/actors/index.md | 4 +--- .../integrations/actors/integrating_actors_via_api.md | 2 -- .../platform/integrations/actors/integration_ready_actors.md | 2 -- sources/platform/integrations/index.mdx | 2 -- sources/platform/proxy/datacenter_proxy.md | 2 -- sources/platform/proxy/google_serp_proxy.md | 2 -- sources/platform/proxy/residential_proxy.md | 2 -- sources/platform/proxy/usage.md | 2 -- sources/platform/proxy/your_own_proxies.md | 2 -- 22 files changed, 13 insertions(+), 51 deletions(-) diff --git a/sources/platform/actors/development/actor_definition/dataset_schema/index.md b/sources/platform/actors/development/actor_definition/dataset_schema/index.md index dea04e0562..f1e3aa2a07 100644 --- a/sources/platform/actors/development/actor_definition/dataset_schema/index.md +++ b/sources/platform/actors/development/actor_definition/dataset_schema/index.md @@ -1,12 +1,11 @@ --- -title: Dataset schema +title: Dataset Schema Specification sidebar_position: 3 description: Learn how to define and present your dataset schema in an user-friendly output UI. slug: /actors/development/actor-definition/dataset-schema +sidebar_label: Dataset schema --- -# Dataset Schema Specification - **Learn how to define and present your dataset schema in an user-friendly output UI.** --- diff --git a/sources/platform/actors/development/actor_definition/input_schema/specification.md b/sources/platform/actors/development/actor_definition/input_schema/specification.md index 793b041d5c..6939af0c39 100644 --- a/sources/platform/actors/development/actor_definition/input_schema/specification.md +++ b/sources/platform/actors/development/actor_definition/input_schema/specification.md @@ -1,13 +1,12 @@ --- -title: Input schema specification +title: Actor input schema specification sidebar_position: 2 description: Learn how to define and validate a schema for your Actor's input with code examples. Provide an autogenerated input UI for your Actor's users. slug: /actors/development/actor-definition/input-schema/specification/v1 toc_max_heading_level: 5 +sidebar_label: Input schema specification --- -# Actor input schema specification - **Learn how to define and validate a schema for your Actor's input with code examples. Provide an autogenerated input UI for your Actor's users.** --- diff --git a/sources/platform/actors/development/actor_definition/key_value_store_schema/index.md b/sources/platform/actors/development/actor_definition/key_value_store_schema/index.md index 05934b8d67..cb742e0d85 100644 --- a/sources/platform/actors/development/actor_definition/key_value_store_schema/index.md +++ b/sources/platform/actors/development/actor_definition/key_value_store_schema/index.md @@ -6,8 +6,6 @@ description: Learn how to define and present your key-value store schema to orga slug: /actors/development/actor-definition/key-value-store-schema --- -# Key-value Store Schema Specification - **Learn how to define and present your key-value store schema to organize records into collections.** --- diff --git a/sources/platform/actors/development/automated_tests.md b/sources/platform/actors/development/automated_tests.md index 33a5510a40..967d3f4e80 100644 --- a/sources/platform/actors/development/automated_tests.md +++ b/sources/platform/actors/development/automated_tests.md @@ -1,8 +1,9 @@ --- -title: Automated tests +title: Automated tests for Actors description: Learn how to automate ongoing testing and make sure your Actors perform over time. See code examples for configuring the Actor Testing Actor. slug: /actors/development/automated-tests sidebar_position: 9 +sidebar_label: Automated tests --- **Learn how to automate ongoing testing and make sure your Actors perform over time. See code examples for configuring the Actor Testing Actor.** @@ -12,8 +13,6 @@ import TabItem from '@theme/TabItem'; --- -# Automated tests for Actors - Automated testing is crucial for maintaining the reliability and performance of your Actors over time. This guide will help you set up automated tests using the [Actor Testing Actor](https://apify.com/pocesar/actor-testing). ## Set up automated tests diff --git a/sources/platform/actors/development/builds_and_runs/state_persistence.md b/sources/platform/actors/development/builds_and_runs/state_persistence.md index 627c6cb796..218b88f387 100644 --- a/sources/platform/actors/development/builds_and_runs/state_persistence.md +++ b/sources/platform/actors/development/builds_and_runs/state_persistence.md @@ -4,8 +4,6 @@ description: Learn how to maintain an Actor's state to prevent data loss during slug: /actors/development/builds-and-runs/state-persistence --- -# State persistence - **Learn how to maintain an Actor's state to prevent data loss during unexpected restarts. Includes code examples for handling server migrations.** import Tabs from '@theme/Tabs'; diff --git a/sources/platform/actors/development/deployment/continuous_integration.md b/sources/platform/actors/development/deployment/continuous_integration.md index 9c7fec9b9d..9f7d0e3bc7 100644 --- a/sources/platform/actors/development/deployment/continuous_integration.md +++ b/sources/platform/actors/development/deployment/continuous_integration.md @@ -6,8 +6,6 @@ slug: /actors/development/deployment/continuous-integration sidebar_position: 2 --- -# Continuous integration for Actors - **Learn how to set up automated builds, deploys, and testing for your Actors.** import Tabs from '@theme/Tabs'; diff --git a/sources/platform/actors/development/programming_interface/environment_variables.md b/sources/platform/actors/development/programming_interface/environment_variables.md index 97b2d5836e..0176e776a2 100644 --- a/sources/platform/actors/development/programming_interface/environment_variables.md +++ b/sources/platform/actors/development/programming_interface/environment_variables.md @@ -1,12 +1,11 @@ --- -title: Environment variables +title: Actor environment variables description: Learn how to provide your Actor with context that determines its behavior through a plethora of pre-defined environment variables offered by the Apify SDK. slug: /actors/development/programming-interface/environment-variables sidebar_position: 3 +sidebar_label: Environment variables --- -# Actor environment variables - **Learn how to provide your Actor with context that determines its behavior through a plethora of pre-defined environment variables set by the Apify platform.** import Tabs from '@theme/Tabs'; diff --git a/sources/platform/actors/development/programming_interface/system_events.md b/sources/platform/actors/development/programming_interface/system_events.md index 2202c92f76..bcb9e8c10c 100644 --- a/sources/platform/actors/development/programming_interface/system_events.md +++ b/sources/platform/actors/development/programming_interface/system_events.md @@ -1,12 +1,11 @@ --- -title: System events +title: System events in Apify Actors description: Learn about system events sent to your Actor and how to benefit from them. slug: /actors/development/programming-interface/system-events sidebar_position: 4 +sidebar_label: System events --- -# System events in Apify Actors - **Learn about system events sent to your Actor and how to benefit from them.** import Tabs from '@theme/Tabs'; diff --git a/sources/platform/actors/running/usage_and_resources.md b/sources/platform/actors/running/usage_and_resources.md index b75a002f7f..5a42b7675b 100644 --- a/sources/platform/actors/running/usage_and_resources.md +++ b/sources/platform/actors/running/usage_and_resources.md @@ -5,8 +5,6 @@ sidebar_position: 2 slug: /actors/running/usage-and-resources --- -# Usage and resources - **Learn about your Actors' memory and processing power requirements, their relationship with Docker resources, minimum requirements for different use cases and its impact on the cost.** --- diff --git a/sources/platform/collaboration/list_of_permissions.md b/sources/platform/collaboration/list_of_permissions.md index 744545939e..582ec6f091 100644 --- a/sources/platform/collaboration/list_of_permissions.md +++ b/sources/platform/collaboration/list_of_permissions.md @@ -5,8 +5,6 @@ sidebar_position: 12.2 slug: /collaboration/list-of-permissions --- -# List of permissions - **Learn about the access rights you can grant to other users. See a list of all access options for Apify resources such as Actors, actActoror runs/tasks and storage.** --- diff --git a/sources/platform/collaboration/organization_account/how_to_use.md b/sources/platform/collaboration/organization_account/how_to_use.md index c051d31d77..b1be294b72 100644 --- a/sources/platform/collaboration/organization_account/how_to_use.md +++ b/sources/platform/collaboration/organization_account/how_to_use.md @@ -1,12 +1,11 @@ --- -title: How to use +title: Using the organization account description: Learn to use and manage your organization account using the Apify Console or API. View the organizations you are in and manage your memberships. sidebar_position: 2 slug: /collaboration/organization-account/how-to-use +sidebar_label: How to use --- -# Using the organization account - **Learn to use and manage your organization account using the Apify Console or API. View the organizations you are in and manage your memberships.** --- diff --git a/sources/platform/collaboration/organization_account/index.md b/sources/platform/collaboration/organization_account/index.md index c79ffe18d4..a45f1f6ce8 100644 --- a/sources/platform/collaboration/organization_account/index.md +++ b/sources/platform/collaboration/organization_account/index.md @@ -5,8 +5,6 @@ sidebar_position: 12.1 slug: /collaboration/organization-account --- -# Organization account - **Create a specialized account for your organization to encourage collaboration and manage permissions. Convert an existing account, or create one from scratch.** --- diff --git a/sources/platform/collaboration/organization_account/setup.md b/sources/platform/collaboration/organization_account/setup.md index 96c8cc452d..d4d69bb79f 100644 --- a/sources/platform/collaboration/organization_account/setup.md +++ b/sources/platform/collaboration/organization_account/setup.md @@ -5,8 +5,6 @@ sidebar_position: 1 slug: /collaboration/organization-account/setup --- -# Setup - **Configure your organization account by inviting new members and assigning their roles. Manage team members' access permissions to the organization's resources.** --- diff --git a/sources/platform/integrations/actors/index.md b/sources/platform/integrations/actors/index.md index 8279e66b1e..18435148fd 100644 --- a/sources/platform/integrations/actors/index.md +++ b/sources/platform/integrations/actors/index.md @@ -1,12 +1,10 @@ --- -title: Actor-to-Actor integration +title: What are Actor integrations? description: Learn how to integrate with other Actors and tasks. sidebar_label: Actor-to-Actor slug: /integrations/actors --- -# What are Actor integrations? - **Learn how to integrate with other Actors and tasks.** --- diff --git a/sources/platform/integrations/actors/integrating_actors_via_api.md b/sources/platform/integrations/actors/integrating_actors_via_api.md index e13fd8133b..a2cca419c1 100644 --- a/sources/platform/integrations/actors/integrating_actors_via_api.md +++ b/sources/platform/integrations/actors/integrating_actors_via_api.md @@ -5,8 +5,6 @@ sidebar_position: 2 slug: /integrations/actors/integrating-actors-via-api --- -# Integrating Actors via API - **Learn how to integrate with other Actors and tasks using the Apify API.** import Tabs from '@theme/Tabs'; diff --git a/sources/platform/integrations/actors/integration_ready_actors.md b/sources/platform/integrations/actors/integration_ready_actors.md index e7b40bb697..b4f0e66fa2 100644 --- a/sources/platform/integrations/actors/integration_ready_actors.md +++ b/sources/platform/integrations/actors/integration_ready_actors.md @@ -5,8 +5,6 @@ sidebar_position: 1 slug: /integrations/actors/integration-ready-actors --- -# Integration-ready Actors - **Learn how to create Actors that are ready to be integrated with other Actors and tasks.** --- diff --git a/sources/platform/integrations/index.mdx b/sources/platform/integrations/index.mdx index aea89c1393..ef2bd39738 100644 --- a/sources/platform/integrations/index.mdx +++ b/sources/platform/integrations/index.mdx @@ -9,8 +9,6 @@ slug: /integrations import Card from '@site/src/components/Card'; import CardGrid from '@site/src/components/CardGrid'; -# Integrations - **Learn how to integrate the Apify platform with other services, your systems, data pipelines, and other web automation workflows.** --- diff --git a/sources/platform/proxy/datacenter_proxy.md b/sources/platform/proxy/datacenter_proxy.md index a2b2f9b6d8..69f9df9144 100644 --- a/sources/platform/proxy/datacenter_proxy.md +++ b/sources/platform/proxy/datacenter_proxy.md @@ -8,8 +8,6 @@ slug: /proxy/datacenter-proxy import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Datacenter proxy - **Learn how to reduce blocking when web scraping using IP address rotation. See proxy parameters and learn to implement Apify Proxy in an application.** --- diff --git a/sources/platform/proxy/google_serp_proxy.md b/sources/platform/proxy/google_serp_proxy.md index 8a3987983e..a4f313a977 100644 --- a/sources/platform/proxy/google_serp_proxy.md +++ b/sources/platform/proxy/google_serp_proxy.md @@ -8,8 +8,6 @@ slug: /proxy/google-serp-proxy import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Google SERP proxy {#google-serp-proxy} - **Learn how to collect search results from Google Search-powered tools. Get search results from localized domains in multiple countries, e.g. the US and Germany.** --- diff --git a/sources/platform/proxy/residential_proxy.md b/sources/platform/proxy/residential_proxy.md index 9dc782254c..cad810d09a 100644 --- a/sources/platform/proxy/residential_proxy.md +++ b/sources/platform/proxy/residential_proxy.md @@ -8,8 +8,6 @@ slug: /proxy/residential-proxy import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Residential proxy {#residential-proxy} - **Achieve a higher level of anonymity using IP addresses from human users. Access a wider pool of proxies and reduce blocking by websites' anti-scraping measures.** --- diff --git a/sources/platform/proxy/usage.md b/sources/platform/proxy/usage.md index c930a3dd01..ca0f49dfb5 100644 --- a/sources/platform/proxy/usage.md +++ b/sources/platform/proxy/usage.md @@ -5,8 +5,6 @@ sidebar_position: 10.1 slug: /proxy/usage --- -# Proxy usage - **Learn how to configure and use Apify Proxy. See the required parameters such as the correct username and password.** --- diff --git a/sources/platform/proxy/your_own_proxies.md b/sources/platform/proxy/your_own_proxies.md index e89a5e1308..16cc9e8f77 100644 --- a/sources/platform/proxy/your_own_proxies.md +++ b/sources/platform/proxy/your_own_proxies.md @@ -5,8 +5,6 @@ sidebar_position: 10.5 slug: /proxy/using-your-own-proxies --- -# Using your own proxies - **Learn how to use your own proxies while using the Apify platform.** --- From 0ddc63fb7227237a80354665dcab9acb82f6e8d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Wed, 27 Aug 2025 19:23:10 +0200 Subject: [PATCH 2/4] remove explicit heading anchors --- .../collaboration/list_of_permissions.md | 18 +++++++++--------- .../organization_account/how_to_use.md | 8 ++++---- .../organization_account/index.md | 6 +++--- .../organization_account/setup.md | 4 ++-- .../platform/integrations/programming/api.md | 2 +- .../workflows-and-notifications/make/index.md | 2 +- .../workflows-and-notifications/slack.md | 6 +++--- sources/platform/proxy/datacenter_proxy.md | 10 +++++----- sources/platform/proxy/google_serp_proxy.md | 12 ++++++------ sources/platform/proxy/index.md | 4 ++-- sources/platform/proxy/residential_proxy.md | 14 +++++++------- sources/platform/proxy/usage.md | 2 +- sources/platform/proxy/your_own_proxies.md | 4 ++-- 13 files changed, 46 insertions(+), 46 deletions(-) diff --git a/sources/platform/collaboration/list_of_permissions.md b/sources/platform/collaboration/list_of_permissions.md index 582ec6f091..aa17698ea3 100644 --- a/sources/platform/collaboration/list_of_permissions.md +++ b/sources/platform/collaboration/list_of_permissions.md @@ -11,11 +11,11 @@ slug: /collaboration/list-of-permissions This document contains all the access options that can be granted to resources on the Apify platform. -## Actors {#actors} +## Actors Click [here](../actors/index.mdx) to learn about Apify Actors. -### Actor {#actor} +### Actor | Permission | Description | |----------------------|------------------------------------------------------------| @@ -25,7 +25,7 @@ Click [here](../actors/index.mdx) to learn about Apify Actors. | View runs | View a list of Actor runs and their details. | | Manage access rights | Manage Actor access rights. | -### Actor task {#actor-task} +### Actor task | Permission | Description | |----------------------|------------------------------------------------------------| @@ -36,11 +36,11 @@ Click [here](../actors/index.mdx) to learn about Apify Actors. To learn about Actor tasks, see the [documentation](../actors/running/tasks.md). -## Storage {#storage} +## Storage For more information about Storage, see its [documentation](../storage/index.md). -### Dataset {#dataset} +### Dataset | Permission | Description | |----------------------|-----------------------------------------------------------------| @@ -50,7 +50,7 @@ For more information about Storage, see its [documentation](../storage/index.md) To learn about dataset storage, see its [documentation](../storage/dataset.md). -### Key-value-store {#key-value-store} +### Key-value-store | Permission | Description | |----------------------|---------------------------------------------------------------------------------------------------| @@ -60,7 +60,7 @@ To learn about dataset storage, see its [documentation](../storage/dataset.md). To learn about key-value stores, see the [documentation](../storage/key_value_store.md). -### Request queue {#request-queue} +### Request queue | Permission | Description | |----------------------|------------------------------------------------------------------------------------------------| @@ -70,7 +70,7 @@ To learn about key-value stores, see the [documentation](../storage/key_value_st To learn about request queue storage, see the [documentation](../storage/request_queue.md). -## Proxy {#proxy} +## Proxy | Permission | Description | |------------|---------------------------| @@ -78,7 +78,7 @@ To learn about request queue storage, see the [documentation](../storage/request To learn about Apify Proxy, see its [documentation](../proxy/index.md). -## User permissions {#user-permissions} +## User permissions Permissions that can be granted to members of organizations. To learn about the organization account, see its [documentation](./organization_account/index.md). diff --git a/sources/platform/collaboration/organization_account/how_to_use.md b/sources/platform/collaboration/organization_account/how_to_use.md index b1be294b72..ee54ae198b 100644 --- a/sources/platform/collaboration/organization_account/how_to_use.md +++ b/sources/platform/collaboration/organization_account/how_to_use.md @@ -16,7 +16,7 @@ While you can't manage an organization account via [API](/api/v2), you can still **[See our video tutorial](https://www.youtube.com/watch?v=BIL6HqtnvKk) on organization accounts.** -## In the Apify Console {#in-the-apify-console} +## In the Apify Console You can switch into **Organization account** view using the account button in the top-left corner. @@ -28,7 +28,7 @@ The resources you can access and account details you can edit will depend on you > When switching between accounts, beware which account you start an Actor run in. If you accidentally start an organization's Actor run in your personal account, the run will be billed to your account (and vice versa). -### Manage your organizations {#manage-your-organizations} +### Manage your organizations You can view and manage the organizations you are a member of from the **Organizations** tab on your [account page](https://console.apify.com/account#/myorganization). @@ -36,11 +36,11 @@ If you want to leave an organization you own, you must first transfer ownership ![My organizations](../images/organizations/my-organizations.png) -### Transfer ownership {#transfer-ownership} +### Transfer ownership The organization, its Actors, and its integrations will keep running as they are. The original owner will either leave the organization or become a member with permissions defined by the new owner. Only the new owner will have complete access to the organization. -## Via API {#via-api} +## Via API While you cannot manage an organization account's settings and members via API, you can access its Actor and task runs, webhooks, schedules, and storages just as you would with any other account. diff --git a/sources/platform/collaboration/organization_account/index.md b/sources/platform/collaboration/organization_account/index.md index a45f1f6ce8..32842512ec 100644 --- a/sources/platform/collaboration/organization_account/index.md +++ b/sources/platform/collaboration/organization_account/index.md @@ -20,11 +20,11 @@ You can set up an organization in two ways. > Prefer video to reading? [See our video tutorial](https://www.youtube.com/watch?v=BIL6HqtnvKk) for organization accounts. -## Availability and pricing {#availability-and-pricing} +## Availability and pricing The organization account is available on all our plans. [Visit our pricing page](https://apify.com/pricing) for more information. -## Create a new organization {#create-a-new-organization} +## Create a new organization You can create a new organization by clicking the **Create new organization** button under the **Organizations** tab in your [account](https://console.apify.com/account#/myorganizations). If you want the organization to have a separate email address (used for notifications), enter it here. Otherwise, leave the **email** field empty and the owner's email will be used for notifications. @@ -32,7 +32,7 @@ You can create a new organization by clicking the **Create new organization** bu **You can own up to 5 and be a member of as many organizations as you need.** -## Convert an existing account {#convert-an-existing-account} +## Convert an existing account > **When you convert an existing user account into an organization,** > diff --git a/sources/platform/collaboration/organization_account/setup.md b/sources/platform/collaboration/organization_account/setup.md index d4d69bb79f..ab93a7b29e 100644 --- a/sources/platform/collaboration/organization_account/setup.md +++ b/sources/platform/collaboration/organization_account/setup.md @@ -25,13 +25,13 @@ In the **Account** tab's **Security** section, you can set security requirements **[See our video tutorial](https://www.youtube.com/watch?v=BIL6HqtnvKk) on organization accounts.** -## Add users to your organization {#add-users-to-your-organization} +## Add users to your organization You can add members to your organization in the **Members** tab. You can use their **User ID**, **username**, or **email**. When adding a member to the organization, you must assign them a **Role** so their permissions are known right away. ![Organization members](../images/organizations/members.png) -## Define roles and permissions {#define-roles-and-permissions} +## Define roles and permissions Roles allow you to define permissions to your organization's resources by group. Every new organization comes with three pre-defined roles, which you can customize or remove. diff --git a/sources/platform/integrations/programming/api.md b/sources/platform/integrations/programming/api.md index 9bec56d87c..b303a0ffa4 100644 --- a/sources/platform/integrations/programming/api.md +++ b/sources/platform/integrations/programming/api.md @@ -63,7 +63,7 @@ The Personal API tokens are different from your own Personal API tokens mentione On the other hand the Organization API tokens (only visible if you are the owner or have Manage access tokens permission) have full permissions and are not tied to a specific member of the organization. -## API tokens with limited permissions {#limited-permissions} +## API tokens with limited permissions By default, tokens can access all data in your account. If that is not desirable, you can choose to limit the permissions of your token, so that it can only access data needed for the particular use case. We call these tokens **scoped**. diff --git a/sources/platform/integrations/workflows-and-notifications/make/index.md b/sources/platform/integrations/workflows-and-notifications/make/index.md index 9e23bfcd09..5943aca327 100644 --- a/sources/platform/integrations/workflows-and-notifications/make/index.md +++ b/sources/platform/integrations/workflows-and-notifications/make/index.md @@ -12,7 +12,7 @@ slug: /integrations/make [Make](https://www.make.com/) _(formerly Integromat)_ allows you to create scenarios where you can integrate various services (modules) to automate and centralize jobs. Apify has its own module you can use to run Apify Actors, get notified about run statuses, and receive Actor results directly in your Make scenario. -## Connect Apify to Make {#connect-apify-to-make} +## Connect Apify to Make To use the Apify integration on Make, you will need: diff --git a/sources/platform/integrations/workflows-and-notifications/slack.md b/sources/platform/integrations/workflows-and-notifications/slack.md index 10b62efc98..ed46810a76 100644 --- a/sources/platform/integrations/workflows-and-notifications/slack.md +++ b/sources/platform/integrations/workflows-and-notifications/slack.md @@ -24,7 +24,7 @@ To use the Apify integration for Slack, you will need: - An [Apify account](https://console.apify.com/). - A Slack account (and workspace). -## Step 1: Set up the integration for Slack {#step-one} +## Step 1: Set up the integration for Slack You can find all integrations on an Actor's or task's **Integrations** tab. For example, you can try using the [Google Shopping Scraper](https://console.apify.com/actors/aLTexEuCetoJNL9bL). @@ -38,11 +38,11 @@ Then, head back to your task to finish the setup. Select what type of events you Once you are done, click the **Save** button. -## Step 2: Give the Apify integration a trial run! {#step-two} +## Step 2: Give the Apify integration a trial run Click the **Start** button and head to the Slack channel you selected to see your first Apify integration notifications. -## Step 3: Start your run directly from Slack {#step-three} +## Step 3: Start your run directly from Slack You can now run the same Actor or task directly from Slack by typing `/apify call [Actor or task ID]` into the Slack message box. diff --git a/sources/platform/proxy/datacenter_proxy.md b/sources/platform/proxy/datacenter_proxy.md index 69f9df9144..1cf81cb789 100644 --- a/sources/platform/proxy/datacenter_proxy.md +++ b/sources/platform/proxy/datacenter_proxy.md @@ -18,7 +18,7 @@ Datacenter proxies allow you to mask and [rotate](./usage.md#ip-address-rotation You can refer to our [blog post](https://blog.apify.com/datacenter-proxies-when-to-use-them-and-how-to-make-the-most-of-them/) for tips on how to make the most out of datacenter proxies. -## Features {#features} +## Features * Periodic health checks of proxies in the pool so requests are not forwarded via dead proxies. * Intelligent rotation of IP addresses so target hosts are accessed via proxies that have accessed them the longest time ago, to reduce the chance of blocking. @@ -33,13 +33,13 @@ You can refer to our [blog post](https://blog.apify.com/datacenter-proxies-when- When using Apify's datacenter proxies, you can either select a proxy group, or the `auto` mode. [Apify Proxy](https://apify.com/proxy) offers either proxy groups that are shared across multiple customers or dedicated ones. -### Shared proxy groups {#shared-proxy-groups} +### Shared proxy groups Each user has access to a selected number of proxy servers from a shared pool. These servers are spread into groups (called proxy groups). Each group shares a common feature (location, provider, speed, etc.). For a full list of plans and number of allocated proxy servers for each plan, see our [pricing](https://apify.com/pricing). To get access to more servers, you can upgrade your plan in the [subscription settings](https://console.apify.com/billing/subscription); -### Dedicated proxy groups {#dedicated-proxy-groups} +### Dedicated proxy groups When you purchase access to dedicated proxy groups, they are assigned to you, and only you can use them. You gain access to a range of static IP addresses from these groups. @@ -47,7 +47,7 @@ This feature is also useful if you have your own pool of proxy servers and still Prices for dedicated proxy servers are mainly based on the number of proxy servers, their type, and location. [Contact us](https://apify.com/contact) for more information. -## Connecting to datacenter proxies {#connecting-to-datacenter-proxies} +## Connecting to datacenter proxies By default, each proxied HTTP request is potentially sent via a different target proxy server, which adds overhead and could be potentially problematic for websites which save cookies based on IP address. @@ -314,7 +314,7 @@ await Actor.exit(); -## Examples using standard libraries and languages {#examples-using-standard-libraries-and-languages} +## Examples using standard libraries and languages You can find your proxy password on the [Proxy page](https://console.apify.com/proxy) of the Apify Console. diff --git a/sources/platform/proxy/google_serp_proxy.md b/sources/platform/proxy/google_serp_proxy.md index a4f313a977..bba4ecb9d0 100644 --- a/sources/platform/proxy/google_serp_proxy.md +++ b/sources/platform/proxy/google_serp_proxy.md @@ -24,7 +24,7 @@ Our Google SERP proxy currently supports the below services. When using the proxy, **pricing is based on the number of requests made**. -## Connecting to Google SERP proxy {#connecting-to-google-serp-proxy} +## Connecting to Google SERP proxy Requests made through the proxy are automatically routed through a proxy server from the selected country and pure **HTML code of the search result page is returned**. @@ -32,7 +32,7 @@ Requests made through the proxy are automatically routed through a proxy server For code examples on how to connect to Google SERP proxies, see the [examples](#examples-using-the-apify-sdk) section. -### Username parameters {#username-parameters} +### Username parameters The `username` field enables you to pass various [parameters](./usage.md#username-parameters), such as groups and country, for your proxy connection. @@ -46,7 +46,7 @@ Unlike [datacenter](./datacenter_proxy.md) or [residential](./residential_proxy. If you use the `country` [parameter](./usage.md), the Google proxy location is used if you access a website whose hostname (stripped of `www.`) starts with **google**. -## Country selection {#country-selection} +## Country selection You must use the correct Google domain to get results for your desired country code. @@ -59,9 +59,9 @@ For example: See a [full list](https://ipfs.io/ipfs/QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco/wiki/List_of_Google_domains.html) of available domain names for specific countries. When using them, remember to prepend the domain name with the `www.` prefix. -## Examples {#examples} +## Examples -### Using the Apify SDK {#examples-using-the-apify-sdk} +### Using the Apify SDK If you are developing your own Apify [Actor](../actors/index.mdx) using the [Apify SDK](/sdk) and [Crawlee](https://crawlee.dev/), the most efficient way to use Google SERP proxy is [CheerioCrawler](https://crawlee.dev/api/cheerio-crawler/class/CheerioCrawler). This is because Google SERP proxy [only returns a page's HTML](./index.md). Alternatively, you can use the [got-scraping](https://github.com/apify/got-scraping) [NPM package](https://www.npmjs.com/package/got-scraping) by specifying the proxy URL in the options. For Python, you can leverage the [`requests`](https://pypi.org/project/requests/) library along with the Apify SDK. @@ -145,7 +145,7 @@ await Actor.exit(); -### Using standard libraries and languages {#using-standard-libraries-and-languages} +### Using standard libraries and languages You can find your proxy password on the [Proxy page](https://console.apify.com/proxy/access) of Apify Console. diff --git a/sources/platform/proxy/index.md b/sources/platform/proxy/index.md index 7397d12728..1ae1bf2e06 100644 --- a/sources/platform/proxy/index.md +++ b/sources/platform/proxy/index.md @@ -22,7 +22,7 @@ You can use proxies in your [Actors](../actors/index.mdx) or any other applicati You can view your proxy settings and password on the [Proxy](https://console.apify.com/proxy) page in Apify Console. For pricing information, visit [apify.com/pricing](https://apify.com/pricing). -## Quickstart {#quickstart} +## Quickstart Usage of Apify Proxy means just a couple of lines of code, thanks to our [SDKs](/sdk): @@ -76,7 +76,7 @@ if __name__ == '__main__': -## Proxy types {#proxy-types} +## Proxy types Several types of proxy servers exist, each offering distinct advantages, disadvantages, and varying pricing structures. You can use them to access websites from various geographies and with different levels of anonymity. diff --git a/sources/platform/proxy/residential_proxy.md b/sources/platform/proxy/residential_proxy.md index cad810d09a..18fa525984 100644 --- a/sources/platform/proxy/residential_proxy.md +++ b/sources/platform/proxy/residential_proxy.md @@ -20,7 +20,7 @@ Residential proxies support [IP address rotation](./usage.md#ip-address-rotation **Pricing is based on data traffic**. It is measured for each connection made and displayed on your [proxy usage dashboard](https://console.apify.com/proxy/usage) in the Apify Console. -## Connecting to residential proxy {#connecting-to-residential-proxy} +## Connecting to residential proxy Connecting to residential proxy works the same way as [datacenter proxy](./datacenter_proxy.md), with two differences. @@ -28,7 +28,7 @@ Connecting to residential proxy works the same way as [datacenter proxy](./datac 2. You can specify the country in which you want your proxies to be. -### How to set a proxy group {#how-to-set-a-proxy-group} +### How to set a proxy group When using [standard libraries and languages](./datacenter_proxy.md), specify the `groups` parameter in the [username](./usage.md#username-parameters) as `groups-RESIDENTIAL`. @@ -71,7 +71,7 @@ async def main(): -### How to set a proxy country {#how-to-set-a-proxy-country} +### How to set a proxy country When using [standard libraries and languages](./datacenter_proxy.md), specify the `country` parameter in the [username](./usage.md#username-parameters) as `country-COUNTRY-CODE`. @@ -118,7 +118,7 @@ async def main(): -## Session persistence {#session-persistence} +## Session persistence When using residential proxy with the `session` [parameter](./usage.md#sessions) set in the [username](./usage.md#username-parameters), a single IP address is assigned to the **session ID** provided after you make the first request. @@ -133,7 +133,7 @@ If the proxy server becomes unresponsive or the session expires, a new IP addres To learn more about [sessions](./usage.md#sessions) and [IP address rotation](./usage.md#ip-address-rotation), see the proxy [overview page](./index.md). -## Tips to keep in mind {#tips-to-keep-in-mind} +## Tips to keep in mind [Residential](./index.md) proxies are less predictable than [datacenter](./datacenter_proxy.md) proxies and are priced differently (by number of IPs vs traffic used). Because of this, there are some important things to consider before using residential proxy in your solutions. @@ -143,13 +143,13 @@ Residential proxy is priced by data traffic used. Thus, it's easy to quickly use To reduce your traffic use, we recommend using the `blockRequests()` function of [`playwrightUtils`](https://crawlee.dev/api/playwright-crawler/namespace/playwrightUtils#blockRequests)/[`puppeteerUtils`](https://crawlee.dev/api/puppeteer-crawler/namespace/puppeteerUtils#blockRequests) (depending on the library used). -### Connected proxy speed variation {#connected-proxy-speed-variation} +### Connected proxy speed variation Each host on the residential proxy network uses a different device. They have different network speeds and different latencies. This means that requests made with one [session](./usage.md#sessions) can be extremely fast, while another request with a different session can be extremely slow. The difference can range from a few milliseconds to a few seconds. If your solution requires quickly loaded content, the best option is to set a [session](./usage.md#sessions), try a small request and see if the response time is acceptable. If it is, you can use this session for other requests. Otherwise, repeat the attempt with a different session. -### Connection interruptions {#connection-interruptions} +### Connection interruptions While sessions are persistent, they can be destroyed at any time if the host devices are turned off or disconnected. diff --git a/sources/platform/proxy/usage.md b/sources/platform/proxy/usage.md index ca0f49dfb5..0203aeb2f4 100644 --- a/sources/platform/proxy/usage.md +++ b/sources/platform/proxy/usage.md @@ -143,7 +143,7 @@ Depending on whether you use a [browser](https://apify.com/apify/web-scraper) or Use [sessions](#sessions) to control how you rotate IP addresses. See our guide [Anti-scraping techniques](/academy/anti-scraping/techniques) to learn more about IP address rotation and our findings on how blocking works. -## Sessions {#sessions} +## Sessions Sessions allow you to use the same IP address for multiple connections. In cases where you need to keep the same session (e.g. when you need to log in to a website), it is best to keep the same proxy and so the IP address. On the other hand by switching the IP address, you can avoid being blocked by the website. diff --git a/sources/platform/proxy/your_own_proxies.md b/sources/platform/proxy/your_own_proxies.md index 16cc9e8f77..3f2be86712 100644 --- a/sources/platform/proxy/your_own_proxies.md +++ b/sources/platform/proxy/your_own_proxies.md @@ -11,12 +11,12 @@ slug: /proxy/using-your-own-proxies In addition to our proxies, you can use your own both in Apify Console and SDK. -## Custom proxies in console {#console} +## Custom proxies in console To use your own proxies with Apify Console, in your Actor's **Input and options** tab, scroll down and open the **Proxy and browser configuration** section. Enter your proxy URLs, and you're good to go. ![Using custom proxy in Apify Console](../images/proxy-custom.png) -## Custom proxies in SDK {#SDK} +## Custom proxies in SDK In the Apify SDK, use the `proxyConfiguration.newUrl(sessionId)` (JavaScript) or `proxy_configuration.new_url(session_id)` (Python) command to add your custom proxy URLs to the proxy configuration. See the [JavaScript](/sdk/js/api/apify/class/ProxyConfiguration#newUrl) or [Python](/sdk/python/reference/class/ProxyConfiguration#new_url) SDK docs for more details. From aa31856362faa49a6f80a8f933ffdbcd23f00847 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Wed, 27 Aug 2025 19:27:21 +0200 Subject: [PATCH 3/4] fix mdlint --- sources/platform/collaboration/list_of_permissions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sources/platform/collaboration/list_of_permissions.md b/sources/platform/collaboration/list_of_permissions.md index aa17698ea3..abd7e1cceb 100644 --- a/sources/platform/collaboration/list_of_permissions.md +++ b/sources/platform/collaboration/list_of_permissions.md @@ -13,7 +13,7 @@ This document contains all the access options that can be granted to resources o ## Actors -Click [here](../actors/index.mdx) to learn about Apify Actors. +To learn about Apify Actors, check out the [documentation](../actors/index.mdx). ### Actor From 5ecd4c44ab1866701a6e4d27a518d91e242f0380 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Wed, 27 Aug 2025 19:28:57 +0200 Subject: [PATCH 4/4] title case > sentence case --- .../actors/development/actor_definition/dataset_schema/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sources/platform/actors/development/actor_definition/dataset_schema/index.md b/sources/platform/actors/development/actor_definition/dataset_schema/index.md index f1e3aa2a07..70516ab551 100644 --- a/sources/platform/actors/development/actor_definition/dataset_schema/index.md +++ b/sources/platform/actors/development/actor_definition/dataset_schema/index.md @@ -1,5 +1,5 @@ --- -title: Dataset Schema Specification +title: Dataset schema specification sidebar_position: 3 description: Learn how to define and present your dataset schema in an user-friendly output UI. slug: /actors/development/actor-definition/dataset-schema