Skip to content

Commit ab138f5

Browse files
authored
2 parents 90cd642 + b713ecf commit ab138f5

File tree

6 files changed

+75
-0
lines changed

6 files changed

+75
-0
lines changed
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: Actor Status Badge
3+
description: Apify has a QA system that regularly runs automated tests to ensure that all Actors in the store are functional.
4+
slug: /actors/publishing/status-badge
5+
sidebar_position: 4
6+
---
7+
8+
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.
9+
10+
---
11+
import Tabs from '@theme/Tabs';
12+
import TabItem from '@theme/TabItem';
13+
14+
## Actor status badge example
15+
16+
This is the badge generated for the [Apify's Website Content Crawler](https://apify.com/apify/website-content-crawler) Actor.
17+
18+
[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler)](https://apify.com/apify/website-content-crawler)
19+
20+
21+
### How to embed the Actor Status Badge
22+
23+
The Badge is a dynamic SVG image loaded from the Apify platform. The Badge is served from the URL Template:
24+
25+
```text
26+
https://apify.com/actor-badge?actor=:username/:actor-name
27+
```
28+
29+
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.
30+
31+
#### Example
32+
<!-- vale off -->
33+
<Tabs>
34+
<TabItem value="html" label="HTML Example" default>
35+
```html
36+
<a href="https://apify.com/apify/website-content-crawler">
37+
<img src="https://apify.com/actor-badge?actor=apify/website-content-crawler">
38+
</a>
39+
```
40+
</TabItem>
41+
<TabItem value="markdown" label="Markdown Example">
42+
```markdown
43+
[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler\)](https://apify.com/apify/website-content-crawler)
44+
```
45+
</TabItem>
46+
</Tabs>
47+
<!-- vale on -->
48+
### Supported Actor states
49+
50+
The badge indicates the state of the Actor in the Apify Platform as the result of the [automated testing](../development/automated_tests.md).
51+
52+
#### Actor OK
53+
54+
![Actor badge OK](./images/actor-badge/ok.svg)
55+
56+
#### Actor under maintenance
57+
58+
![Actor badge under maintenance](./images/actor-badge/under-maintenance.svg)
59+
60+
#### Actor deprecated
61+
62+
![Actor badge deprecated](./images/actor-badge/deprecated.svg)
63+
64+
#### Actor not found
65+
66+
![Actor badge not found](./images/actor-badge/not-found.svg)
67+
68+
### Example of the Badge in Github README
69+
70+
![Actor badge in githhub readme](images/github-badge-screenshot.png)
71+
Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading
387 KB
Loading

0 commit comments

Comments
 (0)