diff --git a/sources/platform/actors/publishing/badge.mdx b/sources/platform/actors/publishing/badge.mdx index b6dfaf3bb4..c23eca6c73 100644 --- a/sources/platform/actors/publishing/badge.mdx +++ b/sources/platform/actors/publishing/badge.mdx @@ -1,36 +1,44 @@ --- title: Actor status badge -description: The Actor status badge can be embedded in the README or documentation to show users the current status and usage of your Actor on the Apify platform. +description: Learn how to use the Actor status badge to show users the current status and usage information of your Actor on the Apify platform. slug: /actors/publishing/status-badge sidebar_position: 4 --- -The Actor status badge can be embedded in the README or documentation to show users the current status and usage of your Actor on the Apify platform. - ---- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This is the badge generated for the [Apify's Website Content Crawler](https://apify.com/apify/website-content-crawler) Actor: +You can embed the Actor status badge in your README or documentation to show users the current status and usage information of your Actor on the Apify platform. -[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler)](https://apify.com/apify/website-content-crawler) +![Actor status badge in GitHub README](images/actor-badge/actor-status-badge.svg) -This is how such a badge looks in a GitHub repository README: +## Supported statuses -![Actor badge in GitHub README](images/github-badge-screenshot.png) +The badge displays the status of your Actor in the Apify platform based on the result of the [automated testing](../development/automated_tests.md) process. The following statuses are supported: +- Actor OK + ![Actor OK status badge](./images/actor-badge/ok.svg) +- Actor under maintenance + ![Actor under maintenance status badge](./images/actor-badge/under-maintenance.svg) +- Actor deprecated + ![Actor deprecated status badge](./images/actor-badge/deprecated.svg) +- Actor not found + ![Actor not found status badge](./images/actor-badge/not-found.svg) -### How to embed the badge +## Embed the status badge -The Badge is a dynamic SVG image loaded from the Apify platform. The Badge is served from the URL Template: +The status badge is a dynamic SVG image loaded from the Apify platform and served from the following URL template: ```text https://apify.com/actor-badge?actor=/ ``` -In order to embed the badge in the HTML documentation, just use it as an image wrapped in a link as shown in the example below. Don't forget to use the `username` and `actor-name` of your Actor. +Where: -#### Example +- `` is your Apify username. +- `` is the name of your Actor. + +To embed the badge in your HTML documentation, use the badge URL as an image wrapped in a link: @@ -46,24 +54,3 @@ In order to embed the badge in the HTML documentation, just use it as an image w ``` - -### Supported Actor states - -The badge indicates the state of the Actor in the Apify platform as the result of the [automated testing](../development/automated_tests.md). - -#### Actor OK - -![Actor badge OK](./images/actor-badge/ok.svg) - -#### Actor under maintenance - -![Actor badge under maintenance](./images/actor-badge/under-maintenance.svg) - -#### Actor deprecated - -![Actor badge deprecated](./images/actor-badge/deprecated.svg) - -#### Actor not found - -![Actor badge not found](./images/actor-badge/not-found.svg) - diff --git a/sources/platform/actors/publishing/images/actor-badge/actor-status-badge.svg b/sources/platform/actors/publishing/images/actor-badge/actor-status-badge.svg new file mode 100644 index 0000000000..21ade64456 --- /dev/null +++ b/sources/platform/actors/publishing/images/actor-badge/actor-status-badge.svg @@ -0,0 +1,58 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/sources/platform/actors/publishing/images/github-badge-screenshot.png b/sources/platform/actors/publishing/images/github-badge-screenshot.png deleted file mode 100644 index 3a9ee6086b..0000000000 Binary files a/sources/platform/actors/publishing/images/github-badge-screenshot.png and /dev/null differ