Skip to content

Commit 9278201

Browse files
committed
docs: restructure and enhance documentation for Actor publication
Reorganized the content into a more logical structure with clear sections and headings. Simplified and clarified the language to improve readability and comprehension for developers. Provided step-by-step instructions for accessing publication settings, writing descriptions and READMEs, and publishing the Actor. Emphasized the importance of following SEO best practices for descriptions and READMEs.
1 parent 10f96fc commit 9278201

File tree

1 file changed

+28
-17
lines changed

1 file changed

+28
-17
lines changed

sources/platform/actors/publishing/publish.mdx

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,50 +9,61 @@ sidebar_position: 1
99

1010
---
1111

12-
Before you make your Actor public, it is important to make sure your Actor has good **Description** and **README** sections so that users can understand what your Actor does, how to configure its inputs, and what kind of output it returns. In this lesson, we will briefly review each field you must fill in before publishing your Actor. For more detailed information about [SEO and promotion](/academy/get-most-of-actors/seo-and-promotion) and [how to write a comprehensive README](/academy/get-most-of-actors/actor-readme), check our guides at Apify Developer Academy.
12+
Before making your Actor public, it's important to ensure your Actor has a clear **Description** and comprehensive **README** section. This will help users understand your Actor's purpose, how to configure its inputs, and the type of output it generates. This guide we'll review the essential fields you must complete before publishing your Actor. For more detaileted information on [SEO, promotion](/academy/get-most-of-actors/seo-and-promotion) and [how to write a comprehensive README](/academy/get-most-of-actors/actor-readme),refer to guited available at the [Apify Academy](https://docs.apify.com/academy).
1313

14-
You can find the Title and description configurations by going to **Apify Console****Actors****My Actors****your-actor****Settings → Publication**
14+
## Access Actor publication settings
15+
16+
To access the publication settings for your Actor, follow these steps:
17+
18+
1. Go to the Apify Console
19+
2. Navigate to **Actors** > **My Actors**
20+
3. Select your Actor
21+
4. Click on the **Settings** > **Publication**
1522

1623
![Actor publication settings](./images/actor-publication-settings.webp)
1724

18-
## Description {#description}
25+
### Description
1926

20-
The Actor's description is a short paragraph describing the Actor's purpose. It will be displayed on the Actor's page right below its title.
27+
The Actor's description is a short paragraph that explains its purpose. It will be displayed on the Actor's page, right below its title.
2128

2229
![Actor title and description](./images/actor-title-description.webp)
2330

24-
While writing your Actor's description, you also have the option to write an SEO title and description. The SEO title and description are used in place of the Actor name and description on search engine results pages. Good SEO titles and descriptions utilize popular keywords, summarize the Actor functionality, and are between 40–50 and 140–156 characters long respectively.
31+
When writing your Actor's description, you also have the option to provide an SEO title & description. These will be used in search engine result pages instead of Actor's name & description. Effective SEO titles & descriptions should:
32+
33+
- Utilize popular keywords related to your Actor's functionality
34+
- Summarize the Actor's purpose concisely
35+
- Be between _40_ to _50_ characters for the title and _140_ to _156_ characters for description
2536

2637
![SEO title and description](./images/actor-SEO.webp)
2738

28-
## README {#readme}
39+
### README
2940

30-
The next step is to include a **README** detailing the Actor's features, reasons to scrape the target website, and an explanation of how to use the Actor.
41+
The next step is to include a comprehensive **README** detailing your Actor's features, reasons for scraping the target website, and instructions on how to use the Actor effectively.
3142

32-
Keep in mind that the Actor's README is generated from your README.md file, and you can apply the same [SEO principles](/academy/get-most-of-actors/seo-and-promotion) described in the previous lesson to your README.
43+
Remember that the Actor's README is generated from your `README.md` file, and you can apply the same [SEO principles](/academy/get-most-of-actors/seo-and-promotion) mentioned earlier to optimize you README for search engines.
3344

34-
To save some time when writing an Actor's README, you can use the template below as a starting point:
45+
To save time when writing your Actor's README, you can use the following template as a starting point:
3546

3647
https://github.com/zpelechova/readme-template
3748

38-
Note that the complexity of the README should match the Actor's complexity. This means that the template above is not immutable and that you can adapt it to fit the particularities of your Actor.
49+
Note that the complexity of your README should match the complexity of your Actor. Feel free to adapt the template to fit your Actor's specific requirements.
3950

40-
## Make your Actor Public {#make-your-actor-public}
51+
## Make your Actor Public
4152

42-
Once you have finished coding and testing your Actor, it's time to publish it.
53+
Once you've finished coding and testing your Actor, it's time to publish it. Follow these steps:
4354

44-
From your Actor's page in Apify Console, go to **Publication → Display information**, fill in all the relevant fields for your Actor (e.g., "Icons","Actor name", "Description", "Categories") and save it.
55+
1. From your Actor's page in the Apify Console, go to **Publication** > **Display information**
56+
2. Fill in all the relevaent fields for your Actor (e.g., **Icons**, **Actor name**, **Description**, **Categories**)
57+
3. Save your changes
4558

4659
![Actor settings](./images/actor-display-information.webp)
4760

48-
Once all the fields are filled in, you will notice that the button **Publish to Store** will turn green. Just click on it and your Actor should now be available to the public on Apify Store.
61+
After filling in all the required fields, the **Publish to Store** button will turn green. Click on it to make your Actor available to the public on the Apify Store.
4962

5063
![Publish your Actor](./images/publish-actor-to-store.webp)
5164

52-
To check if everything went smoothly, you can go to [Apify Store](https://apify.com/store) and search for your Actor's name.
65+
To verity that your Actor has been published successfully, go to the Apify Store, search for your Actor's name. Click on your Actor's card, to view its dedicated page. This is the page where users will likely have their first interaction with your ACtor, so carefully review it and ensure everything is set up correctly.
5366

5467
![Apify Store](./images/Apify-Store.webp)
5568

56-
Then, click on your Actor's card to see your dedicated Actor's page. This is the page where users will most likely have their first contact with your Actor, so make sure to carefully review it and check if everything is set up correctly.
57-
5869
![Actor page](./images/actor-page.webp)

0 commit comments

Comments
 (0)