Skip to content

Commit 70b445a

Browse files
committed
feat: Actor Badge
1 parent 897aea5 commit 70b445a

File tree

6 files changed

+59
-0
lines changed

6 files changed

+59
-0
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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+
12+
### How to embed the Actor Status Badge
13+
14+
The Badge is a dynamic SVG image loaded from the Apify platform. The Badge is served from the URL Template:
15+
```
16+
https://apify.com/actor-badge?actor=:username/:actor-name
17+
```
18+
19+
#### HTML Example
20+
```html
21+
<a href="https://apify.com/apify/website-content-crawler">
22+
<img src="https://apify.com/actor-badge?actor=apify/website-content-crawler">
23+
</a>
24+
```
25+
26+
#### Markdown Example
27+
```markdown
28+
[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler)](https://apify.com/apify/website-content-crawler)
29+
```
30+
31+
#### Rendered Example
32+
[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler)](https://apify.com/apify/website-content-crawler)
33+
34+
### Supported Actor States
35+
36+
The badge indicates the state of the Actor in the Apify Platform as the result of the [automated testing](../development/automated_tests.md).
37+
38+
#### Actor OK
39+
![actor badge ok](./images/actor-badge/ok.svg)
40+
41+
#### Actor Under Maintenance
42+
![actor badge under maintenance](./images/actor-badge/under-maintenance.svg)
43+
#### Actor Deprecated
44+
![actor badge deprecated](./images/actor-badge/deprecated.svg)
45+
46+
#### Actor Not Found
47+
![actor badge ok](./images/actor-badge/not-found.svg)
48+
49+
50+
### Example of the Badge in Github Readme
51+
![actor badge in githhub readme](images/github-badge-screenshot.png)
52+
53+
54+
55+
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)