-
Notifications
You must be signed in to change notification settings - Fork 150
docs: Add more info about free users #2150
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
patrikbraborec
wants to merge
5
commits into
master
Choose a base branch
from
docs/free-users
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+27
−11
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
803f9d6
docs: Add more info about free users
patrikbraborec 911fa3c
docs: Fix lint errors
patrikbraborec 449beba
docs: Fix lint errors
patrikbraborec 51f6094
docs: Change position of text
patrikbraborec 3358426
docs: Fix formatting
patrikbraborec File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -15,7 +15,7 @@ import TabItem from '@theme/TabItem'; | |||||||||
| Each Actor run has a status, represented by the `status` field. The following table describes the possible values: | ||||||||||
|
|
||||||||||
| |Status|Type|Description| | ||||||||||
| |--- |--- |--- | | ||||||||||
| |---|---|---| | ||||||||||
| |`READY`|initial|Started but not allocated to any worker yet| | ||||||||||
| |`RUNNING`|transitional|Executing on a worker| | ||||||||||
| |`SUCCEEDED`|terminal|Finished successfully| | ||||||||||
|
|
@@ -76,3 +76,11 @@ async def main(): | |||||||||
|
|
||||||||||
| </TabItem> | ||||||||||
| </Tabs> | ||||||||||
|
|
||||||||||
| ## Communicating limitations | ||||||||||
|
|
||||||||||
| If your Actor has specific limitations for users on the Apify free plan (e.g., restricted features, limited results), it is crucial to communicate these clearly to avoid confusion. | ||||||||||
|
|
||||||||||
| - Status messages: Use `setStatusMessage` or the exit message to explain why a run finished early or failed (e.g., "Daily limit for free plan reached. Upgrade to continue."). | ||||||||||
| - Avoid false errors: Do not return generic system errors or fail the run in a way that looks like a platform issue. This frustrates users and makes troubleshooting difficult. | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Again, let's be more perscriptive
Suggested change
|
||||||||||
| - Documentation: Clearly state any limitations in your Actor's `README` and input schema descriptions so users know what to expect before running the Actor. | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's be more direct so they don't need to search the docs. Many devs don't know that
Actor.exithas a status message