Skip to content

Commit e28fdcc

Browse files
authored
docs: update references to SDK/Crawlee + more (#430)
- Updated links, mentioned Crawlee where applicable. - Update/removed some unrelated things which I noticed on the go (e.g. note about migration to new billing, etc).
1 parent 511a884 commit e28fdcc

File tree

72 files changed

+671
-649
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+671
-649
lines changed

content/docs/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ If your needs are more specific, you can order a [custom solution](https://apify
1717

1818
## [](#get-started) Get started
1919

20-
Check out [this video](https://www.youtube.com/watch?v=BsidLZKdYWQ&t=115s) on how to use our **Amazon Scraper** ([vaclavrut/amazon-crawler](https://apify.com/vaclavrut/amazon-crawler)). It introduces how web scraping can help your business and serves as a foundation on how to start using other ready-made actors.
20+
Check out [this video](https://www.youtube.com/watch?v=BsidLZKdYWQ) on how to use our **Amazon Scraper** ([vaclavrut/amazon-crawler](https://apify.com/vaclavrut/amazon-crawler)). It introduces how web scraping can help your business and serves as a foundation on how to start using other ready-made actors.
2121

2222
For an overview of all of Apify's features, take a [tour of the platform](https://www.youtube.com/watch?v=nn-bCRvhNUM).
2323

content/docs/access_rights.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ By default, each system resource (actor, key-value store, run, ...) you create i
1313

1414
## [](#granting-access-rights) Granting access rights
1515

16-
You can easily and securely share your own resources - actors, tasks, key-value stores, datasets and request queues using a [granular](https://www.google.com/search?client=firefox-b-d&q=define+granular+permissions) permissions system. This enables you to, for example, allow your colleague to run an [actor]({{@link actors.md}}) or view a [dataset]({{@link storage/dataset.md}}) but not to modify them.
16+
You can easily and securely share your own resources - actors, tasks, key-value stores, datasets and request queues using a [granular](https://www.google.com/search?client=firefox-b-d&q=define+granular+permissions) permissions system. This enables you to, for example, allow your colleague to run an [actor]({{@link actors.md}}) or view a [dataset]({{@link storage/dataset.md}}), but not to modify them.
1717

1818
You can also grant permission to update an actor and build a new version.
1919
[Storages]({{@link storage.md}}) (key-value stores, request queues and datasets) are sharable the same way with, for example, just **read** permission, or a combination of both **read** and **write** permissions.
2020

21-
> To be able to grant access rights to another user you must have a **username** set in [account settings](https://console.apify.com/account#/profile).
21+
> To be able to grant access rights to another user you must have a **username** set in [account settings](https://console.apify.com/account?tab=settings).
2222
2323
To share an actor, task, key-value store, request queue or dataset, open its **Settings** tab and at the very bottom you will find the **Access rights** section. You can add a collaborator using their **user ID**, **email** or **username**. Once you have added the collaborator, you can configure their permissions.
2424

Binary file not shown.
Binary file not shown.

content/docs/access_rights/list_of_permissions.md

Lines changed: 56 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,24 @@ Click [here]({{@link actors.md}}) to learn about Apify actors.
1616

1717
### [](#actor) Actor
1818

19-
|Permission|Description|
20-
|---|---|
21-
|Read|View actor settings, source code and builds.|
22-
|Write|Edit actor settings and source code.|
23-
|Run|Run any of an actor's builds.|
24-
|Delete|Remove the actor.|
25-
|View runs|View a list of actor runs and their details.|
26-
|Manage access rights|Manage actor access rights.|
19+
| Permission | Description |
20+
|----------------------|----------------------------------------------|
21+
| Read | View actor settings, source code and builds. |
22+
| Write | Edit actor settings and source code. |
23+
| Run | Run any of an actor's builds. |
24+
| Delete | Remove the actor. |
25+
| View runs | View a list of actor runs and their details. |
26+
| Manage access rights | Manage actor access rights. |
2727

2828
### [](#actor-task) Actor task
2929

30-
|Permission|Description|
31-
|---|---|
32-
|Read|View task configuration.|
33-
|Write|Edit task configuration and settings.|
34-
|Delete|Remove the task.|
35-
|View runs|View a list of actor task runs and their details.|
36-
|Manage access rights|Manage actor task access rights.|
30+
| Permission | Description |
31+
|----------------------|---------------------------------------------------|
32+
| Read | View task configuration. |
33+
| Write | Edit task configuration and settings. |
34+
| Delete | Remove the task. |
35+
| View runs | View a list of actor task runs and their details. |
36+
| Manage access rights | Manage actor task access rights. |
3737

3838
To learn about actor tasks, see the [documentation]({{@link actors/tasks.md}}).
3939

@@ -43,71 +43,71 @@ For more information about Storage, see its [documentation]({{@link storage.md}}
4343

4444
### [](#dataset) Dataset
4545

46-
|Permission|Description|
47-
|---|---|
48-
|Read|View dataset information and its data.|
49-
|Write|Edit dataset settings and push data to it.|
50-
|Delete|Remove the dataset.|
51-
|Manage access rights|Manage dataset access rights.|
46+
| Permission | Description |
47+
|----------------------|--------------------------------------------|
48+
| Read | View dataset information and its data. |
49+
| Write | Edit dataset settings and push data to it. |
50+
| Delete | Remove the dataset. |
51+
| Manage access rights | Manage dataset access rights. |
5252

5353
To learn about dataset storage, see its [documentation]({{@link storage/dataset.md}}).
5454

5555
### [](#key-value-store) Key-value-store
5656

57-
|Permission|Description|
58-
|---|---|
59-
|Read|View key-value store details and records.|
60-
|Write|Edit key-value store settings and add, update or <br/> remove its records.|
61-
|Delete|Remove key-value store.|
62-
|Manage access rights|Manage key-value store access rights.|
57+
| Permission | Description |
58+
|----------------------|----------------------------------------------------------------------------|
59+
| Read | View key-value store details and records. |
60+
| Write | Edit key-value store settings and add, update or <br/> remove its records. |
61+
| Delete | Remove key-value store. |
62+
| Manage access rights | Manage key-value store access rights. |
6363

6464
To learn about key-value stores, see the [documentation]({{@link storage/key_value_store.md}}).
6565

6666
### [](#request-queue) Request queue
6767

68-
|Permission|Description|
69-
|---|---|
70-
|Read|View request queue details and records.|
71-
|Write|Edit request queue settings and add, update or <br/> remove its records.|
72-
|Delete|Remove request queue.|
73-
|Manage access rights|Manage request queue access rights.|
68+
| Permission | Description |
69+
|----------------------|--------------------------------------------------------------------------|
70+
| Read | View request queue details and records. |
71+
| Write | Edit request queue settings and add, update or <br/> remove its records. |
72+
| Delete | Remove request queue. |
73+
| Manage access rights | Manage request queue access rights. |
7474

7575
To learn about request queue storage, see the [documentation]({{@link storage/request_queue.md}}).
7676

7777
## [](#schedules) Schedules
7878

79-
|Permission|Description|
80-
|---|---|
81-
|Read|View schedule settings and scheduled actors/tasks.|
82-
|Write|Edit schedule settings and scheduled actors/tasks.|
83-
|Delete|Remove the schedule.|
79+
| Permission | Description |
80+
|------------|----------------------------------------------------|
81+
| Read | View schedule settings and scheduled actors/tasks. |
82+
| Write | Edit schedule settings and scheduled actors/tasks. |
83+
| Delete | Remove the schedule. |
8484

8585
To learn about schedules, see the [documentation]({{@link schedules.md}}).
8686

8787
## [](#proxy) Proxy
8888

89-
|Permission|Description|
90-
|---|---|
91-
|Proxy|Allow to use Apify Proxy.|
89+
| Permission | Description |
90+
|------------|---------------------------|
91+
| Proxy | Allow to use Apify Proxy. |
9292

9393
To learn about Apify Proxy, see its [documentation]({{@link proxy.md}}).
9494

9595
## [](#user-permissions) User permissions
9696

9797
Permissions that can be granted to members of organizations. To learn about the organization account, see its [documentation]({{@link access_rights/organization_account.md}}).
9898

99-
|Permission|Description|
100-
|---|---|
101-
|Manage access keys|Manage account access keys, i.e. API token and proxy password.|
102-
|Update subscription|Update the type of subscription, billing details and payment methods.|
103-
|Update profile|Make changes in profile information.|
104-
|Update email|Update the contact email for the account.|
105-
|Reset password|Reset the account's password.|
106-
|View invoices|See the account's invoices.|
107-
|Manage organization|Change the organization's settings.|
108-
109-
## [](#Custom Solutions) Custom Solutions
110-
111-
|Permission|Description|
112-
|---|---|
113-
|Custom Solutions|Allow access to Custom Solutions.|
99+
| Permission | Description |
100+
|---------------------|-----------------------------------------------------------------------|
101+
| Manage access keys | Manage account access keys, i.e. API token and proxy password. |
102+
| Update subscription | Update the type of subscription, billing details and payment methods. |
103+
| Update profile | Make changes in profile information. |
104+
| Update email | Update the contact email for the account. |
105+
| Reset password | Reset the account's password. |
106+
| View invoices | See the account's invoices. |
107+
| Manage organization | Change the organization's settings. |
108+
109+
## [](#custom-solutions) Custom Solutions
110+
111+
| Permission | Description |
112+
|------------------|-----------------------------------|
113+
| Custom Solutions | Allow access to Custom Solutions. |

content/docs/access_rights/organization_account.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ paths:
88

99
# Organization account
1010

11-
> The organization account is only available to accounts using our [new billing system](https://blog.apify.com/launching-new-billing-system-3a26f8384a44). If you see the [migration message](https://blog.apify.com/launching-new-billing-system-3a26f8384a44#92f7) when you [log in](https://console.apify.com), you will need to migrate.
12-
> ![Migration message]({{@asset access_rights/images/migration-message.webp}})
13-
1411
Organization accounts allow groups to collaborate on projects. It enables you to manage your team members' [permissions]({{@link access_rights/list_of_permissions.md}}) and to centralize your billing without having to share the credentials of a single personal account.
1512

1613
You can [switch]({{@link access_rights/organization_account/how_to_use.md#in-the-apify-console}}) between your personal and organization accounts in just two clicks: in the [Apify Console](https://console.apify.com), click the account button in the top-left corner, then select the organization.
@@ -24,7 +21,7 @@ You can set up an organization in two ways.
2421
2522
## [](#availability-and-pricing) Availability and pricing
2623

27-
The organization account is available on our Team, Business, and Custom plans. [Visit our pricing page](https://apify.com/pricing) for more information.
24+
The organization account is available on all our plans. [Visit our pricing page](https://apify.com/pricing) for more information.
2825

2926
## [](#create-a-new-organization) Create a new organization
3027

@@ -52,15 +49,15 @@ Then, under the **Organizations** [tab](https://console.apify.com/account#/myorg
5249

5350
Next, set the organization's name and click **Convert**.
5451

55-
And that's it! Your personal account becomes the organization and you will be logged out automatically. You can now log into your new personal account with the same credentials as you are currently logged in with. This applies to both **password** and **OAuth** methods.
52+
And that's it! Your personal account becomes the organization, and you will be logged out automatically. You can now log into your new personal account with the same credentials as you are currently logged in with. This applies to both **password** and **OAuth** methods.
5653

5754
For information on [adding members and assigning roles]({{@link access_rights/organization_account/setup.md}}), see the Setup page.
5855

5956
## [](#billing) Billing
6057

6158
Actor and task runs are billed to the account they are started from. **Always make sure you start your runs from the correct account** to avoid having an organization's runs billed to your personal account.
6259

63-
The Team plan is [restricted to 3 seats](https://apify.com/pricing), while the Business plan comes with 5, which you can increase later. If you are on the Business plan and want to add some more seats to the 5 it comes with, head over to your [Billing page and click on Subscriptions](https://console.apify.com/billing-new#/subscription). Click on **Upgrade**, and, in the **Add-ons** section, and add as many additional seats as you need. Then, just complete the upgrade process, and you're done.
60+
The Free and Personal plans are [restricted to 9 seats](https://apify.com/pricing), while the Team plan comes with 9, which you can increase later. If you are on the Team plan and want to add some more seats to the 9 it comes with, head over to your [Billing page and click on Subscriptions](https://console.apify.com/billing-new#/subscription). Click on **Upgrade**, and, in the **Add-ons** section, and add as many additional seats as you need. Then, just complete the upgrade process, and you're done.
6461

6562
![Adding more teams account seats]({{@asset access_rights/images/upgrade.webp}})
6663

content/docs/access_rights/organization_account/how_to_use.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ You can switch into **Organization account** view using the account button in th
2020

2121
![Switch to organization account]({{@asset access_rights/images/switch-to-organization.webp}})
2222

23-
In the menu, the account you are currently using is displayed at the top, with all the accounts you can switch to displayed below. When you need to get back to your personal account, you can just switch right back to itno need to log in and out.
23+
In the menu, the account you are currently using is displayed at the top, with all the accounts you can switch to displayed below. When you need to get back to your personal account, you can just switch right back to itno need to log in and out.
2424

2525
The resources you can access and account details you can edit will depend on your [permissions]({{@link access_rights/list_of_permissions.md#user-permissions}}) in the organization.
2626

content/docs/actors/development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In this section, you can find documentation on creating your own actors using th
1717

1818
Here are some resources that will help you go from beginner to pro. If you have any questions, join other devs on our [Discord server](https://discord.gg/jyEM2PRvMU) or contact us at [[email protected]](mailto:[email protected]).
1919

20-
- Get familiar with [the Apify platform](https://www.youtube.com/watch?v=XPF0kbyvoOs) and [actors]({{@link actors.md}}).
20+
- Get familiar with [the Apify platform](https://www.youtube.com/watch?v=nn-bCRvhNUM) and [actors]({{@link actors.md}}).
2121
- [Check out our public wiki](https://gitlab.com/apify-public/wiki/-/wikis/home). It contains key information, best practices, and advice for building actors.
2222
- [How to and how not to write an actor](https://gitlab.com/apify-public/wiki/-/wikis/writing-actors/how-to-write-and-not-write-an-actor).
2323
- [Actor performance and optimization](https://gitlab.com/apify-public/wiki/-/wikis/writing-actors/actor-performance-and-optimization).

0 commit comments

Comments
 (0)