Skip to content

Commit

Permalink
feat: Actor Status Badge documentation (#1251)
Browse files Browse the repository at this point in the history
  • Loading branch information
netmilk authored Oct 24, 2024
2 parents 90cd642 + b713ecf commit ab138f5
Show file tree
Hide file tree
Showing 6 changed files with 75 additions and 0 deletions.
71 changes: 71 additions & 0 deletions sources/platform/actors/publishing/badge.mdx
Original file line number Diff line number Diff line change
@@ -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
<!-- vale off -->
<Tabs>
<TabItem value="html" label="HTML Example" default>
```html
<a href="https://apify.com/apify/website-content-crawler">
<img src="https://apify.com/actor-badge?actor=apify/website-content-crawler">
</a>
```
</TabItem>
<TabItem value="markdown" label="Markdown Example">
```markdown
[![Website Content Crawler Actor](https://apify.com/actor-badge?actor=apify/website-content-crawler\)](https://apify.com/apify/website-content-crawler)
```
</TabItem>
</Tabs>
<!-- vale on -->
### 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)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ab138f5

Please sign in to comment.