Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion nginx.conf
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,7 @@ server {
rewrite ^/academy/apify-platform/deploying-your-code/docker-file$ /academy/deploying-your-code/docker-file permanent;
rewrite ^/academy/apify-platform/deploying-your-code/input-schema$ /academy/deploying-your-code/input-schema permanent;
rewrite ^/academy/apify-platform/deploying-your-code/inputs-outputs$ /academy/deploying-your-code/inputs-outputs permanent;
rewrite ^/academy/apify-platform/get-most-of-actors/actor-readme$ /academy/actor-marketing-playbook/actor-basics/how-to-create-an-actor-readme permanent;
rewrite ^/academy/apify-platform/get-most-of-actors/actor-readme$ /actors/publishing/actor-readme permanent;
rewrite ^/academy/apify-platform/get-most-of-actors/monetizing-your-actor$ /platform/actors/publishing/monetize permanent;
rewrite ^/academy/apify-platform/get-most-of-actors/naming-your-actor$ /academy/actor-marketing-playbook/actor-basics/name-your-actor permanent;
rewrite ^/academy/apify-platform/get-most-of-actors/seo-and-promotion$ /academy/actor-marketing-playbook/promote-your-actor/seo permanent;
Expand Down Expand Up @@ -785,6 +785,9 @@ server {
rewrite ^/academy/actor-marketing-playbook$ /academy/actor-marketing-playbook/promote-your-actor/checklist permanent;
rewrite ^/academy/get-most-of-actors/monetizing-your-actor$ /platform/actors/publishing/monetize permanent;

# Actor README guide moved from the Academy to Publishing section
rewrite ^/academy/actor-marketing-playbook/actor-basics/how-to-create-an-actor-readme$ /actors/publishing/actor-readme permanent;

# Misc
rewrite ^/platform/integrations/llama$ /platform/integrations/llama-index permanent;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Also, remember that your Actor is a package deal with the Apify platform. All th

Apify Store is like any other marketplace, so take a look at your competition there. Are you the first in your lane, or are there other similar tools? What makes yours stand out? Remember, your README is your first impression - communicate your tool's benefits clearly and offer something unique. Competing with other developers is great, but collaborations can drive even better results 😉

Learn more about what makes a good readme here: [How to create an Actor README](/academy/actor-marketing-playbook/actor-basics/how-to-create-an-actor-readme)
Learn more about what makes a good readme: [Create an Actor README](/actors/publishing/actor-readme).

### Adapt when needed

Expand Down

This file was deleted.

Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,6 @@ Deployment to the Apify platform can be done easily via `apify push` command of

### 6. Publish and monetize

For details on publishing the Actor in [Apify Store](https://apify.com/store) see the [Publishing and monetization](/actors/publishing). You can also follow the guide on [How to create an Actor README](/academy/actor-marketing-playbook/actor-basics/how-to-create-an-actor-readme) and [Marketing checklist](/academy/actor-marketing-playbook/promote-your-actor/checklist).
For details on publishing the Actor in [Apify Store](https://apify.com/store) see the [Publishing and monetization](/actors/publishing). You can also follow the guide on how to [Create an Actor README](/actors/publishing/actor-readme) and [Marketing checklist](/academy/actor-marketing-playbook/promote-your-actor/checklist).

To show your Actor's current status and usage in your README or documentation, add the [Actor status badge](/actors/publishing/status-badge).
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Actor `name`, `version`, `buildTag`, and `environmentVariables` are currently on
| `environmentVariables` | Optional | A map of environment variables to be used during local development. These variables will also be applied to the Actor when deployed on the Apify platform. For more details, see the [environment variables](/cli/docs/vars) section of the Apify CLI documentation. |
| `dockerfile` | Optional | The path to the Dockerfile to be used for building the Actor on the platform. If not specified, the system will search for Dockerfiles in the `.actor/Dockerfile` and `Dockerfile` paths, in that order. Refer to the [Dockerfile](./docker.md) section for more information. |
| `dockerContextDir` | Optional | The path to the directory to be used as the Docker context when building the Actor. The path is relative to the location of the `actor.json` file. This property is useful for monorepos containing multiple Actors. Refer to the [Actor monorepos](../deployment/source_types.md#actor-monorepos) section for more details. |
| `readme` | Optional | The path to the README file to be used on the platform. If not specified, the system will look for README files in the `.actor/README.md` and `README.md` paths, in that order of preference. Check out [Apify Marketing Playbook to learn how to write a quality README files](https://apify.notion.site/How-to-create-an-Actor-README-759a1614daa54bee834ee39fe4d98bc2) guidance. |
| `readme` | Optional | The path to the README file to be used on the platform. If not specified, the system will look for README files in the `.actor/README.md` and `README.md` paths, in that order of preference. For details, see [Create an Actor README](/actors/publishing/actor-readme). |
| `input` | Optional | You can embed your [input schema](./input_schema/index.md) object directly in `actor.json` under the `input` field. You can also provide a path to a custom input schema. If not provided, the input schema at `.actor/INPUT_SCHEMA.json` or `INPUT_SCHEMA.json` is used, in this order of preference. You can also use the `inputSchema` alias interchangeably. |
| `output` | Optional | You can embed your [output schema](./output_schema/index.md) object directly in `actor.json` under the `output` field. You can also provide a path to a custom output schema. [Read more](/actors/development/actor-definition/output-schema) about Actor output schemas. You can also use the `outputSchema` alias interchangeably. |
| `changelog` | Optional | The path to the CHANGELOG file displayed in the Information tab of the Actor in Apify Console next to Readme. If not provided, the CHANGELOG at `.actor/CHANGELOG.md` or `CHANGELOG.md` is used, in this order of preference. Your Actor doesn't need to have a CHANGELOG but it is a good practice to keep it updated for published Actors. |
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion sources/platform/actors/publishing/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ While refactoring and updating your Actor's code is encouraged, be cautious of m

### Documentation and testing

Pay special attention to your Actor's documentation ([README](https://apify.notion.site/How-to-create-an-Actor-README-759a1614daa54bee834ee39fe4d98bc2)). It should be clear, detailed, concise and, readable, using simple language and avoiding technical jargon whenever possible, as your users may not be developers.
Pay special attention to your Actor's documentation ([README](/actors/publishing/actor-readme)). It should be clear, detailed, concise and, readable, using simple language and avoiding technical jargon whenever possible, as your users may not be developers.

Ensure periodic testing, either manually or by [setting up automatic testing](../development/automated_tests.md) and [monitoring](https://apify.com/apify/monitoring). This can help prevent users from encountering issues with your Actor.

Expand Down
2 changes: 1 addition & 1 deletion sources/platform/actors/publishing/publish-task.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can create up to 50 tasks per Actor.

Before you publish a task, make sure you have:

- A [published Actor](./publish.mdx) that you own or maintain.
- A [published Actor](./publish/index.mdx) that you own or maintain.
- A [saved task](/actors/running/tasks) with a complete input configuration.
- An [input schema](/actors/development/actor-definition/input-schema) and at least one [dataset schema view](/storage/dataset-schema) defined on the Actor.

Expand Down
64 changes: 0 additions & 64 deletions sources/platform/actors/publishing/publish.mdx

This file was deleted.

Loading
Loading