-
Notifications
You must be signed in to change notification settings - Fork 133
feat: Actor Badge #1251
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
feat: Actor Badge #1251
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
70b445a
feat: Actor Badge
netmilk 1b51cfe
Actor Capitalization
netmilk 39b6fd4
Fixed img alts for accuracy
netmilk 13d49eb
Fixing markdown lint errorrs
netmilk c6e1aa8
Fixing more markdown lint errors
netmilk 845cd9f
Fixed typo
netmilk 2f000c0
Merge branch 'master' into feat/actor-badge
netmilk 6ba0612
Update sources/platform/actors/publishing/badge.mdx
netmilk a92fe8f
Update sources/platform/actors/publishing/badge.mdx
netmilk 4c18ecc
Update sources/platform/actors/publishing/badge.mdx
netmilk 4ff7bcf
Update sources/platform/actors/publishing/badge.mdx
netmilk 7a5391c
Update sources/platform/actors/publishing/badge.mdx
netmilk 423f417
Update sources/platform/actors/publishing/badge.mdx
netmilk e5ab633
Examples to tabs
netmilk 32b9f56
Attempt to please the linter
netmilk fedd07b
Update sources/platform/actors/publishing/badge.mdx
netmilk b713ecf
Update sources/platform/actors/publishing/badge.mdx
netmilk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. | ||
|
|
||
| [](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 | ||
| [](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 under maintenance | ||
|
|
||
|  | ||
|
|
||
| #### Actor deprecated | ||
|
|
||
|  | ||
|
|
||
| #### Actor not found | ||
|
|
||
|  | ||
|
|
||
| ### Example of the Badge in Github README | ||
|
|
||
|  | ||
|
|
||
1 change: 1 addition & 0 deletions
1
sources/platform/actors/publishing/images/actor-badge/deprecated.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions
1
sources/platform/actors/publishing/images/actor-badge/not-found.svg
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.
1 change: 1 addition & 0 deletions
1
sources/platform/actors/publishing/images/actor-badge/under-maintenance.svg
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.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.