diff --git a/MIGRATIONS.md b/MIGRATIONS.md index dfd8cb5ec9..a58acab7fd 100644 --- a/MIGRATIONS.md +++ b/MIGRATIONS.md @@ -61,7 +61,7 @@ npm install apify playwright If you want to make use of Playwright on the Apify Platform, you need to use a Docker image that supports Playwright. We've created them for you, so head over to the new -[Docker image guide](https://sdk.apify.com/docs/guides/docker-images) and pick the one +[Docker image guide](https://docs.apify.com/sdk/js/docs/concepts/docker-images) and pick the one that best suits your needs. Note that your `package.json` **MUST** include `puppeteer` and/or `playwright` as dependencies. diff --git a/docs/02_concepts/01_actor_lifecycle.mdx b/docs/02_concepts/01_actor_lifecycle.mdx index 9b9944a1cc..fb660e0396 100644 --- a/docs/02_concepts/01_actor_lifecycle.mdx +++ b/docs/02_concepts/01_actor_lifecycle.mdx @@ -65,7 +65,7 @@ variable to your API token. ### Log in with Configuration -Another option is to use the [`Configuration`](https://sdk.apify.com/api/apify/class/Configuration) instance and set your api token there. +Another option is to use the `Configuration` instance and set your api token there. ```javascript import { Actor } from 'apify'; @@ -111,13 +111,13 @@ apify run For running Crawlee code as an actor on [Apify platform](https://apify.com/actors) you should either: -- use a combination of [`Actor.init()`](https://sdk.apify.com/api/apify/class/Actor#init) and [`Actor.exit()`](https://sdk.apify.com/api/apify/class/Actor#exit) functions; -- or wrap it into [`Actor.main()`](https://sdk.apify.com/api/apify/class/Actor#main) function. +- use a combination of `Actor.init()` and `Actor.exit()` functions; +- or wrap it into `Actor.main()` function. :::info NOTE -- Adding [`Actor.init()`](https://sdk.apify.com/api/apify/class/Actor#init) and [`Actor.exit()`](https://sdk.apify.com/api/apify/class/Actor#exit) to your code are the only two important things needed to run it on Apify platform as an actor. `Actor.init()` is needed to initialize your actor (e.g. to set the correct storage implementation), while without `Actor.exit()` the process will simply never stop. -- [`Actor.main()`](https://sdk.apify.com/api/apify/class/Actor#main) is an alternative to `Actor.init()` and `Actor.exit()` as it calls both behind the scenes. +- Adding `Actor.init()` and `Actor.exit()` to your code are the only two important things needed to run it on Apify platform as an actor. `Actor.init()` is needed to initialize your actor (e.g. to set the correct storage implementation), while without `Actor.exit()` the process will simply never stop. +- `Actor.main()` is an alternative to `Actor.init()` and `Actor.exit()` as it calls both behind the scenes. ::: Let's look at the `CheerioCrawler` example from the Quick Start guide: @@ -204,22 +204,22 @@ There are several things worth mentioning here. To simplify access to the _default_ storages, instead of using the helper functions of respective storage classes, you could use: -- [`Actor.setValue()`](https://sdk.apify.com/api/apify/class/Actor#setValue), [`Actor.getValue()`](https://sdk.apify.com/api/apify/class/Actor#getValue), [`Actor.getInput()`](https://sdk.apify.com/api/apify/class/Actor#getInput) for `Key-Value Store` -- [`Actor.pushData()`](https://sdk.apify.com/api/apify/class/Actor#pushData) for `Dataset` +- `Actor.setValue()`, `Actor.getValue()`, `Actor.getInput()` for `Key-Value Store` +- `Actor.pushData()` for `Dataset` ### Using platform storage in a local actor -When you plan to use the platform storage while developing and running your actor locally, you should use [`Actor.openKeyValueStore()`](https://sdk.apify.com/api/apify/class/Actor#openKeyValueStore), [`Actor.openDataset()`](https://sdk.apify.com/api/apify/class/Actor#openDataset) and [`Actor.openRequestQueue()`](https://sdk.apify.com/api/apify/class/Actor#openRequestQueue) to open the respective storage. +When you plan to use the platform storage while developing and running your actor locally, you should use `Actor.openKeyValueStore()`, `Actor.openDataset()` and `Actor.openRequestQueue()` to open the respective storage. -Using each of these methods allows to pass the [`OpenStorageOptions`](https://sdk.apify.com/api/apify/interface/OpenStorageOptions) as a second argument, which has only one optional property: [`forceCloud`](https://sdk.apify.com/api/apify/interface/OpenStorageOptions#forceCloud). If set to `true` - cloud storage will be used instead of the folder on the local disk. +Using each of these methods allows to pass the `OpenStorageOptions` as a second argument, which has only one optional property: `forceCloud`. If set to `true` - cloud storage will be used instead of the folder on the local disk. :::note -If you don't plan to force usage of the platform storages when running the actor locally, there is no need to use the [`Actor`](https://sdk.apify.com/api/apify/class/Actor) class for it. The Crawlee variants `KeyValueStore.open()`, `Dataset.open()` and `RequestQueue.open()` will work the same. +If you don't plan to force usage of the platform storages when running the actor locally, there is no need to use the `Actor` class for it. The Crawlee variants `KeyValueStore.open()`, `Dataset.open()` and `RequestQueue.open()` will work the same. ::: ### Getting public url of an item in the platform storage -If you need to share a link to some file stored in a Key-Value Store on Apify Platform, you can use [`getPublicUrl()`](https://sdk.apify.com/api/apify/class/KeyValueStore#getPublicUrl) method. It accepts only one parameter: `key` - the key of the item you want to share. +If you need to share a link to some file stored in a Key-Value Store on Apify Platform, you can use `getPublicUrl()` method. It accepts only one parameter: `key` - the key of the item you want to share. ```js import { KeyValueStore } from 'apify'; @@ -232,7 +232,7 @@ const url = store.getPublicUrl('your-file'); ### Exporting dataset data -When the `Dataset` is stored on the [Apify platform](https://apify.com/actors), you can export its data to the following formats: HTML, JSON, CSV, Excel, XML and RSS. The datasets are displayed on the actor run details page and in the [Storage](https://console.apify.com/storage) section in the Apify Console. The actual data is exported using the [Get dataset items](https://apify.com/docs/api/v2#/reference/datasets/item-collection/get-items) Apify API endpoint. This way you can easily share the crawling results. +When the `Dataset` is stored on the [Apify platform](https://apify.com/actors), you can export its data to the following formats: HTML, JSON, CSV, Excel, XML and RSS. The datasets are displayed on the actor run details page and in the [Storage](https://console.apify.com/storage) section in the Apify Console. The actual data is exported using the [Get dataset items](https://apify.com/docs/api/v2#/reference/datasets/item-collection/get-items) Apify API endpoint. This way you can easily share the crawling results. **Related links** @@ -312,7 +312,7 @@ const proxyConfiguration = await Actor.createProxyConfiguration(); const proxyUrl = await proxyConfiguration.newUrl(); ``` -Note that unlike using your own proxies in Crawlee, you shouldn't use the constructor to create `ProxyConfiguration` instance. For using Apify Proxy you should create an instance using the [`Actor.createProxyConfiguration()`](https://sdk.apify.com/api/apify/class/Actor#createProxyConfiguration) function instead. +Note that unlike using your own proxies in Crawlee, you shouldn't use the constructor to create `ProxyConfiguration` instance. For using Apify Proxy you should create an instance using the `Actor.createProxyConfiguration()` function instead. ### Apify Proxy Configuration @@ -344,8 +344,8 @@ essentially has two modes: Apify Proxy or Own (third party) proxy. The difference is easy to remember. -- If you're using your own proxies - you should create an instance with the ProxyConfiguration `constructor` function based on the provided `ProxyConfigurationOptions`. -- If you are planning to use Apify Proxy - you should create an instance using the [`Actor.createProxyConfiguration()`](https://sdk.apify.com/api/apify/class/Actor#createProxyConfiguration) function. `ProxyConfigurationOptions.proxyUrls` and `ProxyConfigurationOptions.newUrlFunction` enable use of your custom proxy URLs, whereas all the other options are there to configure Apify Proxy. +- If you're using your own proxies - you should create an instance with the ProxyConfiguration `constructor` function based on the provided `ProxyConfigurationOptions`. +- If you are planning to use Apify Proxy - you should create an instance using the `Actor.createProxyConfiguration()` function. `ProxyConfigurationOptions.proxyUrls` and `ProxyConfigurationOptions.newUrlFunction` enable use of your custom proxy URLs, whereas all the other options are there to configure Apify Proxy. **Related links** diff --git a/docs/03_guides/cheerio_crawler.ts b/docs/03_guides/cheerio_crawler.ts index 9be0c31a79..0452305532 100644 --- a/docs/03_guides/cheerio_crawler.ts +++ b/docs/03_guides/cheerio_crawler.ts @@ -25,7 +25,7 @@ const crawler = new CheerioCrawler({ // This function will be called for each URL to crawl. // It accepts a single parameter, which is an object with options as: - // https://sdk.apify.com/docs/typedefs/cheerio-crawler-options#handlepagefunction + // https://crawlee.dev/js/api/cheerio-crawler/interface/CheerioCrawlerOptions#requestHandler // We use for demonstration only 2 of them: // - request: an instance of the Request class with information such as URL and HTTP method // - $: the cheerio object containing parsed HTML diff --git a/docs/04_upgrading/upgrading_v1.md b/docs/04_upgrading/upgrading_v1.md index 4e921d96ff..fb70f76454 100644 --- a/docs/04_upgrading/upgrading_v1.md +++ b/docs/04_upgrading/upgrading_v1.md @@ -74,7 +74,7 @@ npm install apify playwright If you want to make use of Playwright on the Apify Platform, you need to use a Docker image that supports Playwright. We've created them for you, so head over to the new -[Docker image guide](https://sdk.apify.com/docs/guides/docker-images) and pick the one +[Docker image guide](https://docs.apify.com/sdk/js/docs/concepts/docker-images) and pick the one that best suits your needs. Note that your `package.json` **MUST** include `puppeteer` and/or `playwright` as dependencies. diff --git a/src/proxy_configuration.ts b/src/proxy_configuration.ts index 8c061c74dc..f4aef19a73 100644 --- a/src/proxy_configuration.ts +++ b/src/proxy_configuration.ts @@ -264,7 +264,7 @@ export class ProxyConfiguration extends CoreProxyConfiguration { if (proxyUrls && proxyUrls.some((url) => url?.includes('apify.com'))) { this.log.warning( 'Some Apify proxy features may work incorrectly. Please consider setting up Apify properties instead of `proxyUrls`.\n' + - 'See https://sdk.apify.com/docs/guides/proxy-management#apify-proxy-configuration', + 'See https://docs.apify.com/sdk/js/docs/concepts/proxy-management#apify-proxy-configuration', ); } } diff --git a/website/tools/utils/externalLink.js b/website/tools/utils/externalLink.js index 802d52c1e1..0bdfc063ea 100644 --- a/website/tools/utils/externalLink.js +++ b/website/tools/utils/externalLink.js @@ -2,7 +2,7 @@ const { parse } = require('url'); const visit = import('unist-util-visit').then((m) => m.visit); -const internalUrls = ['sdk.apify.com']; +const internalUrls = ['docs.apify.com']; /** * @param {import('url').UrlWithStringQuery} href