diff --git a/sources/platform/actors/publishing/badge.mdx b/sources/platform/actors/publishing/badge.mdx new file mode 100644 index 000000000..9188b6dd2 --- /dev/null +++ b/sources/platform/actors/publishing/badge.mdx @@ -0,0 +1,71 @@ +--- +title: Actor Status Badge +description: Apify has a QA system that regularly runs automated tests to ensure that all Actors in the store are functional. +slug: /actors/publishing/status-badge +sidebar_position: 4 +--- + +Apify Actor Status Badge can be embedded in 3rd party documentation to show current health status and engagement of the Actor in the Apify Platform. + +--- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +## Actor status badge example + +This is the badge generated for the [Apify's Website Content Crawler](https://apify.com/apify/website-content-crawler) Actor. + +[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler)](https://apify.com/apify/website-content-crawler) + + +### How to embed the Actor Status Badge + +The Badge is a dynamic SVG image loaded from the Apify platform. The Badge is served from the URL Template: + +```text +https://apify.com/actor-badge?actor=:username/:actor-name +``` + +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 froget to use the `username` and `actor-name` of your Actor. + +#### Example + + + + ```html + + + + ``` + + + ```markdown + [![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler\)](https://apify.com/apify/website-content-crawler) + ``` + + + +### 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) + +### Example of the Badge in Github README + +![Actor badge in githhub readme](images/github-badge-screenshot.png) + diff --git a/sources/platform/actors/publishing/images/actor-badge/deprecated.svg b/sources/platform/actors/publishing/images/actor-badge/deprecated.svg new file mode 100644 index 000000000..40544aa05 --- /dev/null +++ b/sources/platform/actors/publishing/images/actor-badge/deprecated.svg @@ -0,0 +1 @@ +apify: runs: 733, users: 40apifyruns: 733, users: 40 \ No newline at end of file diff --git a/sources/platform/actors/publishing/images/actor-badge/not-found.svg b/sources/platform/actors/publishing/images/actor-badge/not-found.svg new file mode 100644 index 000000000..0349fe675 --- /dev/null +++ b/sources/platform/actors/publishing/images/actor-badge/not-found.svg @@ -0,0 +1 @@ +apify: actor not foundapifyactor not found \ No newline at end of file diff --git a/sources/platform/actors/publishing/images/actor-badge/ok.svg b/sources/platform/actors/publishing/images/actor-badge/ok.svg new file mode 100644 index 000000000..3c31cbdf3 --- /dev/null +++ b/sources/platform/actors/publishing/images/actor-badge/ok.svg @@ -0,0 +1 @@ +apify: runs: 165M, users: 69.8kapifyruns: 165M, users: 69.8k \ No newline at end of file diff --git a/sources/platform/actors/publishing/images/actor-badge/under-maintenance.svg b/sources/platform/actors/publishing/images/actor-badge/under-maintenance.svg new file mode 100644 index 000000000..f0ac9094f --- /dev/null +++ b/sources/platform/actors/publishing/images/actor-badge/under-maintenance.svg @@ -0,0 +1 @@ +apify: runs: 73, users: 2apifyruns: 73, users: 2 \ No newline at end of file diff --git a/sources/platform/actors/publishing/images/github-badge-screenshot.png b/sources/platform/actors/publishing/images/github-badge-screenshot.png new file mode 100644 index 000000000..3a9ee6086 Binary files /dev/null and b/sources/platform/actors/publishing/images/github-badge-screenshot.png differ