Skip to content

Commit 0abee3b

Browse files
jancurnTC-MOpatrikbraborec
authored
feat: Minor updates (#1726)
Improved copy about Actors - reused some copy from Actor whitepaper Small improvements. --------- Co-authored-by: Michał Olender <[email protected]> Co-authored-by: Patrik Braborec <[email protected]>
1 parent 484e700 commit 0abee3b

File tree

4 files changed

+41
-11
lines changed

4 files changed

+41
-11
lines changed

apify-docs-theme/src/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ const themeConfig = {
132132
href: 'https://github.com/apify',
133133
},
134134
{
135-
label: 'Actor Whitepaper',
135+
label: 'Actor whitepaper',
136136
href: 'https://whitepaper.actor',
137137
},
138138
],
57.2 KB
Loading

sources/platform/actors/index.mdx

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,20 +31,50 @@ import CardGrid from "@site/src/components/CardGrid";
3131
/>
3232
</CardGrid>
3333

34-
## What is an Actor?
34+
## Actors overview
3535

36-
Actors are serverless programs running in the cloud. They can perform anything from simple actions (such as filling out a web form or sending an email) to complex operations (such as crawling an entire website or removing duplicates from a large dataset). Actor runs can be as short or as long as necessary. They could last seconds, hours, or even infinitely.
36+
Actors are serverless cloud programs that can perform anything from a simple action, like filling out a web form, to a complex operation, like crawling an entire website or removing duplicates from a large dataset. Because Actors can persist their state and be restarted, their runs can be as short or as long as necessary, from seconds to hours, or even indefinitely.
3737

38-
> **To get better idea of what Apify Actors are, visit [Apify Store](https://apify.com/store), and try out some of them!**
39-
> ![Apify Store](./running/images/store-google-maps-scraper.png)
38+
Basically, Actors are programs packaged as Docker images, which accept a well-defined JSON input, perform an action, and optionally produce a well-defined JSON output.
4039

41-
You can use Actors [manually in Apify Console](https://console.apify.com/actors), by using the [API](/api/v2) or [scheduler](../schedules.md). You can easily [integrate them with other apps](../integrations/index.mdx) and share your Actors with other Apify users via [Apify Store](https://apify.com/store) or [access rights](./collaboration/access-rights) system.
40+
:::info Additional context
4241

43-
## Actors are containers
42+
For more context, read the [Actor whitepaper](https://whitepaper.actor/).
4443

45-
A single isolated Actor consists of source code and various settings. You can think of an Actor as a cloud app or service that runs on the Apify platform. The run of an Actor is not limited to the lifetime of a single HTTP transaction. It can run for as long as necessary, even forever.
44+
:::
45+
46+
## Actor components
47+
48+
Actors consist of these elements:
49+
50+
- _Dockerfile_ which specifies where the Actor's source code is, how to build it, and run it.
51+
- _Documentation_ in a form of a README.md file.
52+
- _Input and output schemas_ that describe what input the Actor requires, and what results it produces.
53+
- Access to an out-of-the-box _storage system_ for Actor data, results, and files.
54+
- _Metadata_ such as the Actor name, description, author, and version.
55+
56+
The documentation and input/output schemas help people understand what the Actor does, enter required inputs in the user interface or API, and integrate results into other workflows. Actors can call and interact with each other to build more complex systems from simple ones.
57+
58+
![Apify Actor diagram](./images/apify-actor-drawing.png)
59+
60+
## Build Actors
61+
62+
Build Actors to automate tasks, scrape data, or create custom workflows. The Apify platform gives you everything you need to develop, test, and deploy your code.
63+
64+
Ready to start? Check out the [Actor development documentation](/platform/actors/development).
65+
66+
## Running Actors
67+
68+
You can run Actors manually in [Apify Console](https://console.apify.com/actors), using the [API](/api), [CLI](/cli), or [scheduler](../schedules.md). You can easily [integrate Actors](../integrations/index.mdx) with other apps, [share](../collaboration/access_rights.md) them with other people, [publish](./publishing/index.mdx) them in [Apify Store](https://apify.com/store), and even [monetize](./publishing/monetize.mdx).
69+
70+
:::tip Try Actors
71+
72+
To get a better idea of what Apify Actors are, visit [Apify Store](https://apify.com/store) and try out some of them!
73+
74+
![Apify Store](./running/images/store-google-maps-scraper.png)
75+
76+
:::
4677

47-
Basically, Actors are programs packaged as [Docker images](https://hub.docker.com/), which accept a well-defined JSON input, perform an action, and optionally produce an output.
4878

4979
## Public and private Actors
5080

sources/platform/storage/dataset.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Dataset storage enables you to sequentially save and retrieve data. A unique dat
1919

2020
Typically, datasets comprise results from web scraping, crawling, and data processing jobs. You can visualize this data in a table, where each object is forming a row and its attributes are represented as columns. You have the option to export data in various formats, including JSON, CSV, XML, Excel, HTML Table, RSS or JSONL.
2121

22-
> Named datasets are retained indefinitely. <br/>
23-
> Unnamed datasets expire after 7 days unless otherwise specified. <br/> > [Learn more](/platform/storage/usage#named-and-unnamed-storages)
22+
> Named datasets are retained indefinitely.
23+
> Unnamed datasets expire after 7 days unless otherwise specified. [Learn more](/platform/storage/usage#named-and-unnamed-storages)
2424
2525
Dataset storage is _append-only_ - data can only be added and cannot be modified or deleted once stored.
2626

0 commit comments

Comments
 (0)