From 29685413c2e78f9051b310aac4c6189e0c5b44f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20=C4=8Curn?= Date: Wed, 20 Nov 2024 18:14:21 +0100 Subject: [PATCH 1/3] Update badge.mdx --- sources/platform/actors/publishing/badge.mdx | 22 +++++++++----------- 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/sources/platform/actors/publishing/badge.mdx b/sources/platform/actors/publishing/badge.mdx index de03e0b39..d5bf6b31d 100644 --- a/sources/platform/actors/publishing/badge.mdx +++ b/sources/platform/actors/publishing/badge.mdx @@ -1,24 +1,26 @@ --- title: Actor status badge -description: 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. +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. 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. +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'; -## Actor status badge example - -This is the badge generated for the [Apify's Website Content Crawler](https://apify.com/apify/website-content-crawler) Actor. +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) +This is how such a badge looks in a GitHub repository README: + +![Actor badge in GitHub README](images/github-badge-screenshot.png) + -### How to embed the Actor status badge +### How to embed the badge The Badge is a dynamic SVG image loaded from the Apify platform. The Badge is served from the URL Template: @@ -31,14 +33,14 @@ In order to embed the badge in the HTML documentation, just use it as an image w #### Example - + ```html ``` - + ```markdown [![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler\)](https://apify.com/apify/website-content-crawler) ``` @@ -65,7 +67,3 @@ The badge indicates the state of the Actor in the Apify Platform as the result o ![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) - From 8e8bb8f200a8ad27d6e6f6705ce8af4a76110b32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20=C4=8Curn?= Date: Wed, 20 Nov 2024 18:17:34 +0100 Subject: [PATCH 2/3] Update badge.mdx --- sources/platform/actors/publishing/badge.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sources/platform/actors/publishing/badge.mdx b/sources/platform/actors/publishing/badge.mdx index d5bf6b31d..410fc15ea 100644 --- a/sources/platform/actors/publishing/badge.mdx +++ b/sources/platform/actors/publishing/badge.mdx @@ -25,7 +25,7 @@ This is how such a badge looks in a GitHub repository README: 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 +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 froget to use the `username` and `actor-name` of your Actor. From 3e821f70cec52ac448404dba4406e79c1408498e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20=C4=8Curn?= Date: Wed, 20 Nov 2024 18:19:32 +0100 Subject: [PATCH 3/3] Update badge.mdx --- sources/platform/actors/publishing/badge.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sources/platform/actors/publishing/badge.mdx b/sources/platform/actors/publishing/badge.mdx index 410fc15ea..a074344d1 100644 --- a/sources/platform/actors/publishing/badge.mdx +++ b/sources/platform/actors/publishing/badge.mdx @@ -42,14 +42,14 @@ In order to embed the badge in the HTML documentation, just use it as an image w ```markdown - [![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler\)](https://apify.com/apify/website-content-crawler) + [![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). +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