docs: Add Actor task publication guide#2582
Open
jbartadev wants to merge 8 commits into
Open
Conversation
Contributor
|
✅ Preview for this PR (commit |
jbartadev
added
adhoc
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replace em dashes with hyphens, restore tip examples, fix parallel structure, remove bold from non-UI text, normalize number formatting, and clean up stray double blank lines. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
jbartadev
force-pushed
the
docs/publish-task-guide
branch
from
d7c6127 to
20998b2
Compare
katzino
approved these changes
May 28, 2026
Contributor
katzino
left a comment
katzino
left a comment
There was a problem hiding this comment.
LGTM
Some comments to consider, feel free to discard them all.
jgagne
approved these changes
May 29, 2026
Contributor
jgagne
left a comment
jgagne
left a comment
There was a problem hiding this comment.
Excellent work. I left a few copy suggestions and one question inline. I'm pre-approving, but happy to give it another review after the technical review.
martin-sabo-98
approved these changes
May 29, 2026
Apply feedback from katzino, martin-sabo-98, and jgagne: - Replace "parent Actor" with "the Actor" / "your Actor" - Add Slug field and note about use case categories - Add e-commerce and finance examples to the table - Add dataset schema view to prerequisites - Simplify intro, use colons in lists, define SERP - Replace LLM references with AI agents - Add periods to image alt text - Shorten secret fields text and fix sentence structure Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
marcel-rbro
reviewed
May 29, 2026
Comment on lines
+8
to
+10
| Actor tasks are shareable, pre-configured inputs for your Actors. Published tasks get their own public landing pages that showcase real-world use cases and improve discoverability through search engines and AI agents. | ||
|
|
||
| A published task gets its own public landing page that shows users an example of what the Actor does, what inputs it uses, and what output to expect. Public tasks also appear in your Actor’s **Examples** tab. This helps people searching for or asking AI agents for a specific phrase or use case discover your Actor. Publishing tasks can lead to more page views, more runs, and, for monetized Actors, more revenue. |
Contributor
There was a problem hiding this comment.
Suggested change
| Actor tasks are shareable, pre-configured inputs for your Actors. Published tasks get their own public landing pages that showcase real-world use cases and improve discoverability through search engines and AI agents. | |
| A published task gets its own public landing page that shows users an example of what the Actor does, what inputs it uses, and what output to expect. Public tasks also appear in your Actor’s **Examples** tab. This helps people searching for or asking AI agents for a specific phrase or use case discover your Actor. Publishing tasks can lead to more page views, more runs, and, for monetized Actors, more revenue. | |
| [Actor tasks](/platform/actors/running/tasks) are shareable, pre-configured inputs for your Actors. [Publishing a task](#publish-your-tasks) creates a public landing page that shows what the Actor does, what inputs it uses, and what output to expect. Public tasks also appear in your Actor's **Examples** tab, which helps users discover your Actor through search engines and AI agents. For monetized Actors, this can lead to more page views, more runs, and more revenue. |
Contributor
There was a problem hiding this comment.
My suggestion somewhat clashes with @jgagne's, feel free to discard or combine. Please keep the links, they are my main point.
Comment on lines
+14
to
+22
| Before you publish a task, your Actor itself must already be public. See [Publish your Actor](./publish.mdx) for the prerequisites that apply at the Actor level. | ||
|
|
||
| :::note Prerequisites | ||
|
|
||
| - A published Actor that you own or maintain. | ||
| - A [saved task](../running/tasks.md) with a complete input configuration. | ||
| - An [input schema](/platform/actors/development/actor-definition/input-schema) and at least one [dataset schema view](/platform/actors/development/actor-definition/dataset-schema) defined on the Actor. | ||
|
|
||
| ::: |
Contributor
There was a problem hiding this comment.
Suggested change
| Before you publish a task, your Actor itself must already be public. See [Publish your Actor](./publish.mdx) for the prerequisites that apply at the Actor level. | |
| :::note Prerequisites | |
| - A published Actor that you own or maintain. | |
| - A [saved task](../running/tasks.md) with a complete input configuration. | |
| - An [input schema](/platform/actors/development/actor-definition/input-schema) and at least one [dataset schema view](/platform/actors/development/actor-definition/dataset-schema) defined on the Actor. | |
| ::: | |
| ## Prerequisites | |
| Before you publish a task, make sure you have: | |
| - A [published Actor](./publish.mdx) that you own or maintain. | |
| - A [saved task](/platform/actors/running/tasks) with a complete input configuration. | |
| - An [input schema](/platform/actors/development/actor-definition/input-schema) and at least one [dataset schema view](/platform/actors/development/actor-definition/dataset-schema) defined on the Actor. |
Contributor
There was a problem hiding this comment.
This format is used throughout our docs
|
|
||
| Focus on tasks that represent a real use case someone would search for and that show your Actor solving a specific problem. Not every saved task needs a public landing page. | ||
|
|
||
| ### Demonstrate a specific job-to-be-done |
Contributor
There was a problem hiding this comment.
Suggested change
| ### Demonstrate a specific job-to-be-done | |
| ### Focus on a real use case |
Contributor
There was a problem hiding this comment.
Is there a specific reason to use the phrase "job-to-be-done"?
|
|
||
| The best tasks aim to solve a problem a user actually has. Instead of publishing a generic "default configuration" task, publish one that answers a question someone might type into a search engine or AI agent. | ||
|
|
||
| For example, if you maintain a Google Maps scraper, Amazon scraper and Yahoo scraper Actors: |
Contributor
There was a problem hiding this comment.
Suggested change
| For example, if you maintain a Google Maps scraper, Amazon scraper and Yahoo scraper Actors: | |
| For example, if you maintain Google Maps, Amazon, and Yahoo scraper Actors: |
|
|
||
| For example, if you maintain a Google Maps scraper, Amazon scraper and Yahoo scraper Actors: | ||
|
|
||
| | Weak task | Strong task | |
Contributor
There was a problem hiding this comment.
Suggested change
| | Weak task | Strong task | | |
| | ❌ Weak task | ✅ Strong task | |
Contributor
There was a problem hiding this comment.
This is the most minorest issue, but looks nice :)
|
|
||
| ::: | ||
|
|
||
| ## Make your task public |
Contributor
There was a problem hiding this comment.
Suggested change
| ## Make your task public | |
| ## Publish your tasks |
| Once your task runs reliably and produces the output you want users to see, publish it from Apify Console. | ||
|
|
||
| 1. From your task's page in Apify Console, open the **Publication** tab. | ||
| 1. Complete the 3 sections: **Display information**, **Input**, and **Dataset schema**. |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. Complete the 3 sections: **Display information**, **Input**, and **Dataset schema**. | |
| 1. Complete the three sections: [Display information](#display-information), [Input](#input), and [Dataset schema](#dataset-schema). |
Contributor
There was a problem hiding this comment.
Added links instead of just text
|
|
||
| This section controls how your task appears on the public task landing page and in search results. | ||
|
|
||
| There are 3 fields in this section: |
Contributor
There was a problem hiding this comment.
Suggested change
| There are 3 fields in this section: | |
| There are three fields in this section: |
|
|
||
| :::tip Title format | ||
|
|
||
| Frame the title as the user's job-to-be-done, not as a description of the Actor's mechanics. A good title combines an action, a target, and a qualifier. |
Contributor
There was a problem hiding this comment.
Suggested change
| Frame the title as the user's job-to-be-done, not as a description of the Actor's mechanics. A good title combines an action, a target, and a qualifier. | |
| Frame the title as the user's goal, not as a description of the Actor's mechanics. A good title combines an action, a target, and a qualifier. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added a new guide for publishing Actor tasks as public landing pages
Covers main areas: choosing tasks worth publishing, the publication process, landing page structure, and security (secret field masking).
It's not perfect, but it has all the important information, and we're under time pressure to release this. Feel free to suggest improvements.
Closes https://github.com/apify/apify-core/issues/27587
PREVIEW HERE: https://pr-2582.preview.docs.apify.com/platform/actors/publishing/publish-task