From 65ad6a262bb0580c6d40c31921ef0f12f7fc9b3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Wed, 11 Dec 2024 13:29:06 +0100 Subject: [PATCH 1/4] docs:add marketing playbook to docs remove pages covered by marketing playbok add mmarketing playbook link to index page rework index page --- .../get_most_of_actors/actor_readme.md | 97 -------------- .../guidelines_for_writing.md | 111 --------------- .../platform/get_most_of_actors/index.md | 19 ++- .../get_most_of_actors/naming_your_actor.md | 70 ---------- .../get_most_of_actors/seo_and_promotion.md | 126 ------------------ 5 files changed, 9 insertions(+), 414 deletions(-) delete mode 100644 sources/academy/platform/get_most_of_actors/actor_readme.md delete mode 100644 sources/academy/platform/get_most_of_actors/guidelines_for_writing.md delete mode 100644 sources/academy/platform/get_most_of_actors/naming_your_actor.md delete mode 100644 sources/academy/platform/get_most_of_actors/seo_and_promotion.md diff --git a/sources/academy/platform/get_most_of_actors/actor_readme.md b/sources/academy/platform/get_most_of_actors/actor_readme.md deleted file mode 100644 index 4a4ae5205d..0000000000 --- a/sources/academy/platform/get_most_of_actors/actor_readme.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: Actor README -description: Learn how to write a comprehensive README to help users better navigate, understand and run public Actors in Apify Store. -sidebar_position: 2 -slug: /get-most-of-actors/actor-readme ---- - -# Actor README - -**Learn how to write a comprehensive README to help users better navigate, understand and run public Actors in Apify Store.** - ---- - -- It should also be a "template" for developers developing new public Actors so that they have a structure and guidance for writing the README. -- The goal is to ensure that more people will understand and run their Actors. -- Whenever you build an Actor, think of the original request/idea and the "use case" = "user need" it should solve, please take notes and share them with Apify, so we can help you write a blog post supporting your Actor with more information, more detailed explanation, better SEO. -- Consider adding a video, images, and screenshots to your README to break up the text. -- This is an example of an Actor with a README that corresponds well to the guidelines below: - - [apify.com/tri_angle/airbnb-scraper](https://apify.com/tri_angle/airbnb-scraper) -- Tip no.1: if you want to add snippets of code anywhere in your README, you can use [Carbon](https://github.com/carbon-app/carbon). -- Tip no.2: if you need any quick Markdown guidance, check out https://www.markdownguide.org/cheat-sheet/ - -> -> 🦾 **No time for writing?** Our [README Generator](https://apify.com/apify/actor-readme-generator) will create a new README out of thin air following the template below ⬇️ -> - -## What should you add to your Actor README? - -Aim for sections 1–6 below and try to include at least 300 words. You can move the sections around to some extent if it makes sense, e.g. 3 might come after 6. Consider using emojis as bullet points or otherwise trying to break up the text. - -1. **What does (Actor name) do?** - - - in 1–2 sentences describe what the Actor does and what it does not do - - consider adding keywords like API, e.g. Instagram API - - always have a link to the target website in this section - -2. **Why use (Actor name)? or Why scrape (target site)?** - - - How it can be beneficial for the user - - Business use cases - - Link to a success story, a business use case, or a blog post. - -3. **How much will it cost to scrape (target site)?** - - - Explanation of what type of proxies are needed and how many platform credits (calculated mainly from consumption units) are needed for 1000 results. - - This is calculated from carrying out several runs (or from runs saved in the DB). - - Here’s an example for this section: - - > ## How much will it cost me to scrape Google Maps reviews? - > - >
Apify provides you with $5 free usage credits to use every month on the Apify Free plan and you can get up to 100,000 reviews from this Google Maps Reviews Scraper for those credits. This means 100k results will be completely free! - >
But if you need to get more data or to get your data regularly you should grab an Apify subscription. We recommend our $49/month Starter plan - you can get up to 1 million Google Maps reviews every month with the $49 monthly plan! Or 10 million with the $499 Scale plan - wow! - -4. **How to scrape (target site)** - - - Link to "How to…" blogs, if one exists (or suggest one if it doesn't) - - - Add a video tutorial or GIF from an ideal Actor run. - - > Tip: For better user experience, Apify Console automatically renders every YouTube URL as an embedded video player. Add a separate line with the URL of your YouTube video. - - - Consider adding a short numbered tutorial as Google will sometimes pick these up as rich snippets. Remember that this might be in search results, so you can repeat the name of the Actor and give a link, e.g. - - ![How to scrape a website - numbered tutorial](./images/how-to-scrape-target-site.webp) - -5. **Is it legal to scrape (target site)?** - - - This can be used as a boilerplate text for the legal section, but you should use your own judgement and also customize it with the site name. - - > Our scrapers are ethical and do not extract any private user data, such as email addresses, gender, or location. They only extract what the user has chosen to share publicly. We therefore believe that our scrapers, when used for ethical purposes by Apify users, are safe. However, you should be aware that your results could contain personal data. Personal data is protected by the [GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation) in the European Union and by other regulations around the world. You should not scrape personal data unless you have a legitimate reason to do so. If you're unsure whether your reason is legitimate, consult your lawyers. You can also read our blog post on the [legality of web scraping](https://blog.apify.com/is-web-scraping-legal/) - -6. **Input** - - - Refer to the input tab on Actor's detail page. If you like, you can add a screenshot showing the user what the input fields will look like. - - This is an example of how to refer to the input tab: - - > Twitter Scraper has the following input options. Click on the [input tab](https://apify.com/quacker/twitter-scraper/input-schema) for more information. - -7. **Output** - - - Mention "You can download the dataset extracted by (Actor name) in various formats such as JSON, HTML, CSV, or Excel.” - - Add a simplified JSON dataset example, like here: [apify.com/compass/crawler-google-places#output-example](https://apify.com/compass/crawler-google-places#output-example) - -8. **Tips or Advanced options section** - - Share any tips on how to best run the Actor, such as how to limit compute unit usage, get more accurate results, or improve speed. - -If you want some general tips on how to make GitHub README that stands out, check out these guides. Not everything in there will be suitable for an Apify Actor README, so you should cherry-pick what you like and use your imagination. - -
- -[Build a Stunning README For Your GitHub Profile](https://towardsdatascience.com/build-a-stunning-readme-for-your-github-profile-9b80434fe5d7) - -[How to Create a Beautiful README for Your GitHub Profile](https://yushi95.medium.com/how-to-create-a-beautiful-readme-for-your-github-profile-36957caa711c) - -## Next up {#next} - -If you followed all the tips described above, your Actor README is almost good to go! In the [next lesson](./guidelines_for_writing.md) we will give you a few instructions on how you can create a tutorial for your Actor. diff --git a/sources/academy/platform/get_most_of_actors/guidelines_for_writing.md b/sources/academy/platform/get_most_of_actors/guidelines_for_writing.md deleted file mode 100644 index 43ad39b74f..0000000000 --- a/sources/academy/platform/get_most_of_actors/guidelines_for_writing.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: Guidelines for writing tutorials -description: Create a guide for your users so they can get the best out of your Actor. Make sure your tutorial is both user- and SEO-friendly. Your tutorial will be published on Apify Blog. -sidebar_position: 3 -slug: /get-most-of-actors/guidelines-writing-tutorials ---- - -# Guidelines for writing tutorials - -Create a guide for your users so they can get the best out of your Actor. Make sure your tutorial is both user- and SEO-friendly. Your tutorial will be published on [Apify Blog](https://blog.apify.com/). - ---- - -These guidelines are of course not set in stone. They are here to give you a general direction of tried-and-tested ways of creating an Actor tutorial. - -1. **Use markdown formatting.** It might seem like a no-brainer, but it's worth mentioning. Using markdown ensures a smooth transition of your content into our CMS. -2. **Use this structure (also see [the tutorial template](#tutorial-template)):** - 1. Introduce your tool → **What is this X tool for?** - 2. Highlight its unique features → **What data can I scrape with X tool?** - 3. Provide a step-by-step guide, complete with input and output examples → **How to use X tool for scraping X website. Step 1… Step 5.** - 4. Discuss potential use cases → **What are the most frequent use cases of X tool?** - 5. Include a call-to-action (CTA) → **Try this X tool** - 6. Address frequently asked questions (FAQs) - - :::tip - - Feel free to expand beyond this core structure. For inspiration, check out these tutorials: - - - [How to use the Screen Capture tool](https://blog.apify.com/how-to-use-screen-capture-tool/) - - [How to scrape Threads](https://blog.apify.com/how-to-scrape-threads/) - - [How to record tests with the Cypress Recorder extension](https://blog.apify.com/how-to-record-test-cypress-recorder-extension/) - - [Google Lens API: OCR and text image search](https://blog.apify.com/google-lens-api-ocr-text-image-search/) - ::: - -3. **Use SEO tools for keyword research.** Even the best tutorial won't make an impact if it's hidden in the depths of the internet. Use tools like [Answer the Public](https://answerthepublic.com/) to find high-volume, high-cost-per-click keywords related to your topic. -4. **Incorporate relevant links.** While you're writing, look for opportunities to link to other blog posts on the Apify blog that fit well with your topic. Search engines seem to prefer articles that don’t stand alone. -5. **ChatGPT is your friend, but edit wisely.** Feel free to use ChatGPT for generating content, but remember to edit the output. While it's a good tool to get started, it's not perfect and may occasionally make errors. -6. **Additional resources for external writers.** For more details on our tone of voice, image specifications, and other guidelines, visit [Write for Apify](https://apify.com/write-for-apify). -7. After you're done writing, [send your tutorial](mailto:marketing@apify.com) over to one of our writers. They'll take care of it and let you know when it's published. -8. Once your tutorial is published, don't forget to add a link to it to the Actor's README. That way, your tutorial will get its first backlink! It can also be useful for the users skimming through the README in search for detailed instructions. - - -## Tutorial template - -A tutorial template for you to start from. Feel free to expand and modify it as you see fit. - -```markdown -# How to [perform task] automatically - -A step-by-step guide to [describe what the guide helps achieve]. - -The web is a vast and dynamic space, continuously expanding and evolving. Often, there's a need to [describe the problem or need the tool addresses]. A handy tool for anyone who wants to [describe what the tool helps with] would be invaluable. - -[Actor Name], a tool created to [describe what the tool does]. But before we learn how to set it up, let's explore its capabilities. - -## What is [Actor name] for? - -[Describe what sets this tool apart and its key features] - -So, on the one hand, [describe one set of features or benefits]. On the other hand, [describe another set of features or benefits]. Let's see how you can [perform the task the tool is designed for]. - -## What data can I get using [Actor name]? - -[List specific data that this scraping tool can get] - -## How to use [Actor name] - -Here's how to [quick intro to the tutorial itself] - -### Step 1. Find the [Actor name] - -Navigate to [Tool Name] and click the [CTA button]. You'll be redirected to Apify Console. - -### Step 2. Add URL or choose [setting 1], [setting 2], and [setting 3] - -[Describe what the user needs to specify or choose] - -### Step 3. Hit the Start button - -Once you've set everything up, click the Start button. [Describe what happens next] - -### Step 4. Check out your output - -[Describe how to access and use the output] - -### Step 5. Download your data - -[Describe how to download data from Console] - -## What are the most frequent use cases of [Tool Name]? - -[Describe common scenarios where the tool can be useful] - -## FAQs - -### Are there any limitations? - -[Describe any limitations] - -### Can I integrate this tool into my existing project or with other tools? - -[Describe integration possibilities] - -### Can I use this tool to [perform additional tasks]? - -[Describe any additional functionalities] -``` - -## Next up {#next} - -Now that your Actor has a name, a README and you have an idea of making a tutorial for it, let's make sure it's visible to Google and the world. In the [next lesson](./seo_and_promotion.md) we will explore some SEO basics and a few tricks. diff --git a/sources/academy/platform/get_most_of_actors/index.md b/sources/academy/platform/get_most_of_actors/index.md index f6f05cd54c..8c4efb8395 100644 --- a/sources/academy/platform/get_most_of_actors/index.md +++ b/sources/academy/platform/get_most_of_actors/index.md @@ -6,20 +6,19 @@ category: apify platform slug: /get-most-of-actors --- -# Apify Store {#apify-store} - **Learn how to optimize your public Actors on Apify Store and monetize them by renting your Actor to other platform users.** --- -[Apify Store](https://apify.com/store) is home to hundreds of public Actors available to the Apify community. Anyone is welcome to [publish Actors](/platform/actors/publishing) in the store, and you can even [monetize your Actors](https://apify.com/partners/actor-developers). - -In this section, we will go over some of the practical steps you can take to ensure the high quality of your public Actors. You will learn: +The [Apify Store](https://apify.com/store) is a marketplace featuring thousands of ready-made automation tools called Actors. As a developer, you can publish your own Actors and generate revenue through our [monetization program](https://apify.com/partners/actor-developers). -1. Actor naming and README best practices. -2. How to monetize your Actor. -3. Tips and tricks to attract more users to your Actor's page. +To help you succeed, we've created a comprehensive Marketing Playbook. This resource shows you how to: -## Next up {#next} +- Optimize your Actor's visibility in the store +- Create compelling descriptions and documentation +- Build your developer brand +- Promote your work to potential customers +- Analyze performance metrics +- Engage with the Apify community -Without further ado, let's jump [right into the next lesson](./naming_your_actor.md)! +Ready to grow your presence on the platform? Check out our [Marketing Playbook](https://apify.notion.site/3fdc9fd4c8164649a2024c9ca7a2d0da?v=6d262c0b026d49bfa45771cd71f8c9ab) and learn how to [publish your first Actor](/platform/actors/publishing). diff --git a/sources/academy/platform/get_most_of_actors/naming_your_actor.md b/sources/academy/platform/get_most_of_actors/naming_your_actor.md deleted file mode 100644 index 1884865e92..0000000000 --- a/sources/academy/platform/get_most_of_actors/naming_your_actor.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Naming your Actor -description: Apify's standards for Actor naming. Learn how to choose the right name for scraping and non-scraping Actors and how to optimize your Actor for search engines. -sidebar_position: 1 -slug: /get-most-of-actors/naming-your-actor ---- - -# Naming your Actor {#naming-your-actor} - -**Apify's standards for Actor naming. Learn how to choose the right name for scraping and non-scraping Actors and how to optimize your Actor for search engines.** - ---- - -Naming your Actor can be tricky. Especially when you've spent a long time coding and are excited to show your brand-new creation to the world. To help users find your Actor, we've introduced naming standards. These standards improve your Actor's [search engine optimization (SEO)](https://en.wikipedia.org/wiki/Search_engine_optimization) and maintain consistency in the [Apify Store](https://apify.com/store). - -> Your Actor's name should be 3–63 characters long. - -## Scrapers {#scrapers} - -For Actors such as [YouTube Scraper](https://apify.com/streamers/youtube-scraper) or [Amazon Scraper](https://apify.com/junglee/amazon-crawler), which scrape web pages, we usually have one Actor per domain. This helps with naming, as the domain name serves as your Actor's name. - -GOOD: - -- Technical name (Actor's name in the [Apify Console](https://console.apify.com)): **$\{domain}-scraper**, e.g. **youtube-scraper**. -- Publication title for the Apify Store: **$\{Domain} Scraper**, e.g. **YouTube Scraper**. -- Name of the GitHub repository: **actor-$\{domain}-scraper**, e.g. **actor-youtube-scraper**. - -AVOID: - -- Technical name: **the-scraper-of-$\{domain}**, e.g. **the-scraper-of-youtube**. -- Publication title: **The Scraper of $\{Domain}**, e.g. **The Scraper of YouTube**. -- GitHub repository: **actor-the-scraper-of-$\{domain}**, e.g. **actor-the-scraper-of-youtube**. - -If your Actor only caters to a specific service on a domain (and you don't plan on extending it), add the service to the Actor's name. - -For example, - -- Technical name: **$\{domain}-$\{service}-scraper**, e.g. **google-search-scraper**. -- Publication title: **$\{Domain} $\{Service} Scraper**, e.g. [**Google Search Scraper**](https://apify.com/apify/google-search-scraper). -- GitHub repository: **actor-$\{domain}-$\{service}-scraper**, e.g. **actor-google-search-scraper**. - -## Non-scraping Actors {#non-scraping-actors} - -Naming for non-scraping Actors is more liberal. Being creative and considering SEO and user experience are good places to start. Think about what your users will type into a search engine when looking for your Actor. What is your Actor's function? - -If you're having trouble, you can always run your ideas by the Apify team using the chat icon in the bottom-right corner. - -Below are examples for the [Google Sheets](https://apify.com/lukaskrivka/google-sheets) Actor. - -GOOD: - -- Technical name: **google-sheets**. -- Publication title: **Google Sheets Import & Export**. -- GitHub repository: **actor-google-sheets**. - -AVOID: - -- Technical name: **import-to-and-export-from-google-sheets**. -- Publication title: **Actor for Importing to and Exporting from Google Sheets**. -- GitHub repository: **actor-for-import-and-export-google-sheets**. - -## Renaming your Actor {#renaming-your-actor} - -**Warning!** Changing your Actor's **technical name** may break current integrations for that Actor's users. This is why some Actors in the Apify Store don't have consistent naming. For the same reason, it is best to change the Actor's name early, before you build a steady user base. - -The **publication title**, however, can be changed without any problems. - -## Next up {#next} - -Now that your Actor is properly named and you know the differences between your Actor's technical name and publication title, it's time to take the [next step](./actor_readme.md)! into making your Actor public in Apify Store by ensuring that it has a well-structured and comprehensive README. diff --git a/sources/academy/platform/get_most_of_actors/seo_and_promotion.md b/sources/academy/platform/get_most_of_actors/seo_and_promotion.md deleted file mode 100644 index b23fbcc023..0000000000 --- a/sources/academy/platform/get_most_of_actors/seo_and_promotion.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: SEO and promotion -description: Optimize your Actors to get more relevant visits from search engines like Google. Set search engine-friendly parameters and share your Actor with the world. -sidebar_position: 4 -slug: /get-most-of-actors/seo-and-promotion ---- - -# SEO and promotion - -**Optimize your Actors to get more relevant visits from search engines like Google. Set search engine-friendly parameters and share your Actor with the world.** - ---- - -Work on your Actors does not end when you publish it. Now, it's time to promote your creation and get it to its intended audience. The Apify domain will boost your position with search engines but it won't do all the work. Focus on crafting content according to topics and phrases people search for to give your Actor that extra boost. - -**The golden rule of SEO:** Create quality content that provides value and engagement to your users. [Don't over-optimize SEO](https://seo-hacker.com/over-optimization-penalty/) or you risk being penalized by Google. - -Think of it this way: your content, URLs, keywords, titles, links, etc. determine the kind of search queries your page is shown in. The quality of the content determines how high it ranks in those results. - -For example, if you over-optimize your URLs and title to rank higher in results for high-volume queries, but most people who visit your page immediately leave, Google notices, penalizes you, and your pages sink in the results. - -On the other hand, if you precisely address a niche segment of users who will benefit from your Actor and people who open it use your Actor, then Google will love it and push it up in results. Read more about the basics of [content marketing](https://techcrunch.com/2019/04/13/how-do-startups-actually-get-their-content-marketing-to-work/). - -## Keywords - -Several freemium tools exist that help with identifying the right phrases and keywords: - -- [wordstream.com/keywords](https://www.wordstream.com/keywords) -- [neilpatel.com/ubersuggest](https://neilpatel.com/ubersuggest/) -- [keywordtool.io](https://keywordtool.io/) - -Enter the desired phrase or topic (e.g. Facebook scraper, Web scraping, Facebook API...) and set the **language** to **English**. Ideally, set the **location** to **United States**. After submitting the form, you will see a list of relevant phrases for your query with information about **search** volume** (how many people are searching for this) and **competition** (number of results). - -The best combinations are those with **high search volume** and **low competition**. Try to find keywords (or topics) relevant to your Actor based on these criteria. - -**Use your selected keywords on all the important parts of your Actor's page/content**. - -- Page title. -- Meta description. -- Headings (1st and 2nd-level, ideally). -- Page body (e.g., README). -- The texts in your links. - -> While crafting your content with keywords, beware of [over-optimizing or keyword stuffing](https://yoast.com/over-optimized-website/) the page. You can use synonyms or related keywords to help this. Google is smart enough to evaluate the page based on how well the whole topic is covered (not only by keywords), but using them helps. - -## Optimizing your Actor details - -While blog posts and promotion are important, your Actor is the main product. Here's how you can make it more SEO-friendly. - -### Name - -The Actor name is your Actor's developer-style name, which is prefixed by your username (e.g. `jancurn/find-broken-links`). The name is used to generate URL used for your Actor (e.g. https://apify.com/jancurn/find-broken-links), making it an important signal for search engines. The name should also be readable and clear enough, so that people using your Actor can understand what it does. - -[Read more about naming your Actor](./naming_your_actor.md)!. - -### Title - -The Actor title provides a human-readable name. The title is the most important real estate from an SEO standpoint. It should exactly match the most likely search query that potential users of your Actor will use. - -At the same time, it should give your Actor a clear name for people who will use it every day. If you’re working on an "Amazon crawler" or a "Google Places API", use the following formats for your Actor's name: - -> **GOOD**: Crawler for Amazon, API for Google Places, Search in Kickstarter. ->
**BETTER**: Amazon crawler, Google Places API, Kickstarter search. - -### Description - -Your Actor's description should contain a concise but accurate description of what your Actor does, targeted at people who are deciding whether to use it or not. Get straight to the point and avoid any boilerplate text. - -> **GOOD**: Crawls Amazon.com and extracts ...
**AVOID**: This Actor crawls Amazon.com in order to extract ... - -The description is used by search engines to understand what the Actor is about, so it should contain some of the most popular variations and derivations of the [title](#title), including things people might search for. - -> **GOOD**: This Amazon bot will help, whereas the Amazon API won’t. Use the crawler... ->
**AVOID**: This crawler will search through results in Amazon and offers you... - -If you’re not sure about similar phrases, check out the Google suggest tool in the search, and it will show you some hints and tips. Of course, the description should primarily be about what the Actor does, but it’s always a good idea to enrich the text with popular keywords. - -![Google suggestions example](./images/actors-publishing-google.png) - -### README - -The README․md file represents a complete description of your Actor, intended for its users. If your Actor's users are technical folks, you can be technical in the README. If they aren't, keep it simple. [See our article on writing great READMEs](https://help.apify.com/en/articles/2912548-how-to-write-great-readme-for-your-actors). - -You have lots of room for SEO optimization in the README, without compromising readability for your users. Make sure the text includes other variants of what potential users of your Actor might search for. A good place for these is in the captions and headlines but keywords in the body text will also help. It’s also a good idea to repeat the name of the Actor several times. - -> **GOOD**: You can use this Amazon Crawler with your code (Python, PHP, Java) to crawl Amazon without the API... ->
**AVOID**: Follow the instructions in the Readme and if you have any comments, see the FAQ section... - -An important part of SEO is internal and external linking. Don’t be shy - add links to your README leading to similar [Actors](https://apify.com/store) or any interesting article in [Apify Help](https://help.apify.com/) that could assist your users. If your Actor is scraping a certain website, make sure to add a link to that website. If the Actor uses any external libraries, make sure to link their pages. - -If you’ve created other Actors, it’s completely fine to pop in a promo for them at the end. It’s even better if you edit your old Actors and put in a link to your new Actor. We’ll take care of extra promotion on the [Apify homepage](https://apify.com/) or [Apify Store](https://apify.com/store) - especially if you’ve done a great job of describing your Actors! - -> **GOOD**: Like my Amazon Crawler? See my Amazon Review Crawler. ->
**AVOID**: Check out my Amazon Crawler. - -## Promotion - -Now that you’ve created a cool new Actor, let others see it! Share it on your personal Twitter, Facebook, Reddit or any other social platform. Always provide a link with the Actor's name. Use #hashtags on Twitter to catch attention. Provide a small “why is this good” segment when sharing inside any group discussions. We will promote your Actor sooner or later, but more links mean more attention from Google from the beginning. - -### External promotion - -- Try to publish an article about your Actor in relevant external magazines like [hackernoon.com](https://hackernoon.com/) or [techcrunch.com](https://techcrunch.com/). Do not limit yourself to blogging platforms. -- If you publish an article in external media (magazine, blog etc.), be sure to include backlinks to your Actor and the Apify website to strengthen the domain's SEO. -- It's always better to use backlinks with the [`dofollow` attribute](https://raventools.com/marketing-glossary/dofollow-link/). -- Always use the most relevant URL as the backlink's landing page. For example, when talking about Apify Store, link to the Store page ([apify.com/store](https://apify.com/store)), not to Apify homepage ([apify.com](https://apify.com)). -- Always use the most relevant keyword or phrase for the backlink's text. This can boost the landing page's SEO and help the readers know what to expect from the link. - -> **GOOD**: Try the [Facebook scraper](https://apify.com/apify/facebook-pages-scraper) now. ->
**AVOID**: Try the Facebook scraper [here](https://apify.com/apify/facebook-pages-scraper). - -### Social media and forums - -- Use relevant and widely used hashtags (Twitter). - -> **GOOD**: Need to crawl #Amazon or #Yelp? See my Amazon crawler `https://`... ->
**AVOID**: I just #created something, check it out on Apify... - -- Post in groups or pages with relevant target groups (Facebook and LinkedIn). -- Always use the most relevant URL as the backlink's landing page. -- Use other relevant websites for promotion. For example, [news.ycombinator.com](https://news.ycombinator.com/), [producthunt.com](https://www.producthunt.com/), [indiehackers.com](https://www.indiehackers.com/), and [dev.to](https://dev.to/) -- While promoting the Actor on forums like Reddit or Quora, try not to post strictly promotional answers. If you help someone with their problem, all readers will be more willing to upvote your posts or check the Actor. -- If it's possible to upvote your posts, do it and get others to help you. - -## Next up {#next} - -Congratulations! Your Actor is coming together and getting ready to be shared with the world. In the [next lesson](./monetizing_your_actor.md)! we will learn how you can monetize your Actor on Apify Store. From 9b74570bc498286e2e31c4f2eaf853eed7d40b3c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Wed, 11 Dec 2024 13:35:53 +0100 Subject: [PATCH 2/4] remove dead link remove dead links, I didn't add new links since this page is undergoing a rewrite in another PR and I will add backlinks there --- .../platform/get_most_of_actors/monetizing_your_actor.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sources/academy/platform/get_most_of_actors/monetizing_your_actor.md b/sources/academy/platform/get_most_of_actors/monetizing_your_actor.md index b19b8f6e3f..6a7535c0c9 100644 --- a/sources/academy/platform/get_most_of_actors/monetizing_your_actor.md +++ b/sources/academy/platform/get_most_of_actors/monetizing_your_actor.md @@ -136,7 +136,7 @@ Getting new users can be an art in itself, but there are **two proven steps** yo In short, SEO-optimized texts improve the likelihood that potential customers will find your Actor when searching for similar tools on the web. - This can be a daunting task to take on your own, so we prepared an in-depth [SEO guide](./seo_and_promotion.md) to help you **fine-tune your Actor’s title, description, and Readme.** + This can be a daunting task to take on your own, so we prepared an in-depth SEO guide to help you **fine-tune your Actor’s title, description, and Readme.** 2. **Promoting your Actor** @@ -170,4 +170,4 @@ Getting new users can be an art in itself, but there are **two proven steps** yo **Don’t overlook promoting your Actor**. This is arguably the most important step after publishing your tool. Taking advantage of all the possible channels for promotion is what often differentiates very successful Actors with dozens of paid users from Actors with few to no users at all. -Finally, don’t forget to check our [pro-tips](./seo_and_promotion.md) to take your Actor promotion efforts to the next level. +Finally, don’t forget to check our pro-tips to take your Actor promotion efforts to the next level. From 1ba27918b6257d01a25831d4506cf0ea84650d25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Wed, 11 Dec 2024 13:46:19 +0100 Subject: [PATCH 3/4] further dead link removal --- .../actors/development/actor_definition/actor_json.md | 2 +- sources/platform/actors/publishing/index.mdx | 4 ++-- sources/platform/actors/publishing/publish.mdx | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/sources/platform/actors/development/actor_definition/actor_json.md b/sources/platform/actors/development/actor_definition/actor_json.md index d885c3f513..f5fa9ad4d4 100644 --- a/sources/platform/actors/development/actor_definition/actor_json.md +++ b/sources/platform/actors/development/actor_definition/actor_json.md @@ -72,7 +72,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 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 Academy article on writing a quality README files](/academy/get-most-of-actors/actor-readme) 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. 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. | | `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. | | `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. | | `storages.dataset` | Optional | You can define the schema of the items in your dataset under the `storages.dataset` field. This can be either an embedded object or a path to a JSON schema file. [Read more](/platform/actors/development/actor-definition/dataset-schema) about Actor dataset schemas. | diff --git a/sources/platform/actors/publishing/index.mdx b/sources/platform/actors/publishing/index.mdx index da88f4cd08..eca8fb6f02 100644 --- a/sources/platform/actors/publishing/index.mdx +++ b/sources/platform/actors/publishing/index.mdx @@ -19,7 +19,7 @@ To build & publish an Actor on [Apify Store](https://apify.com/store), you'll go 1. [Development](../development/index.md). 2. [Publication](./publishing/publish) and set up of [monetization](./publishing/monetize). 3. [Testing](../development/automated_tests.md). -4. [Promotion](../../academy/get-most-of-actors/seo-and-promotion). +4. [Promotion](https://apify.notion.site/3fdc9fd4c8164649a2024c9ca7a2d0da?v=6d262c0b026d49bfa45771cd71f8c9ab). ## Benefits of publishing and monetization @@ -72,7 +72,7 @@ Ensure periodic testing, either manually or by [setting up automatic testing](.. To find ideas for new Actor, consider the following sources: - Your own experiences with friends, colleagues, and customers -- SEO tools to identify search terms, websites related to web scrapint, web automation, or web integrations (see the[SEO article](../../academy/get-most-of-actors/seo-and-promotion) for more details) +- SEO tools to identify search terms, websites related to web scrapint, web automation, or web integrations (see the[SEO article](https://apify.notion.site/SEO-990259fe88a84fd0a85ce6d3b394d8c1) for more details) - The [Actor ideas page](https://apify.com/ideas) to find Actors in demaed by the Apify community - Our [Discord community](https://discord.com/invite/jyEM2PRvMU), especially the [#hire-freelancers](https://discord.com/channels/801163717915574323/1022804760484659210) channel can offer great insights diff --git a/sources/platform/actors/publishing/publish.mdx b/sources/platform/actors/publishing/publish.mdx index 57e3a2a6ef..92c391035c 100644 --- a/sources/platform/actors/publishing/publish.mdx +++ b/sources/platform/actors/publishing/publish.mdx @@ -9,7 +9,7 @@ sidebar_position: 1 --- -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). +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 detailed information on [SEO & promotion](https://apify.notion.site/SEO-990259fe88a84fd0a85ce6d3b394d8c1) and [how to write a comprehensive README](https://apify.notion.site/How-to-create-an-Actor-README-759a1614daa54bee834ee39fe4d98bc2),refer to guides available at the [Apify Marketing Playbook](https://apify.notion.site/3fdc9fd4c8164649a2024c9ca7a2d0da?v=6d262c0b026d49bfa45771cd71f8c9ab). ## Make your Actor public From 81674b59c40443e23b3a86bdd92f555b21f41bc1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Olender?= <92638966+TC-MO@users.noreply.github.com> Date: Wed, 11 Dec 2024 13:55:59 +0100 Subject: [PATCH 4/4] further link removal --- sources/platform/actors/publishing/index.mdx | 2 +- sources/platform/actors/publishing/publish.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/sources/platform/actors/publishing/index.mdx b/sources/platform/actors/publishing/index.mdx index eca8fb6f02..62fc39ca2a 100644 --- a/sources/platform/actors/publishing/index.mdx +++ b/sources/platform/actors/publishing/index.mdx @@ -63,7 +63,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](../../academy/get-most-of-actors/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. +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. 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. diff --git a/sources/platform/actors/publishing/publish.mdx b/sources/platform/actors/publishing/publish.mdx index 92c391035c..49e4bb7bc9 100644 --- a/sources/platform/actors/publishing/publish.mdx +++ b/sources/platform/actors/publishing/publish.mdx @@ -49,7 +49,7 @@ When writing your Actor's description, you also have the option to provide an SE 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. -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. +Remember that the Actor's README is generated from your `README.md` file, and you can apply the same [SEO principles](https://apify.notion.site/SEO-990259fe88a84fd0a85ce6d3b394d8c1) mentioned earlier to optimize you README for search engines. To save time when writing your Actor's README, you can use the following template as a starting point: