Skip to content

Commit cbbc894

Browse files
committed
reintroduce other Apify-specific rules
turn back Apify-specific rules fix all errors within sources/platform
1 parent d200058 commit cbbc894

File tree

15 files changed

+43
-23
lines changed

15 files changed

+43
-23
lines changed

.github/styles/Apify/Apify.yml

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,24 @@
11
extends: substitution
22
message: "Use '%s' instead of '%s'."
3-
ignorecase: false
3+
ignorecase: true
44
level: warning
5+
scope: text
56
swap:
6-
Apify Dashboard: Apify Console
7-
apify freelancers: Apify freelancers
8-
Apify Platform: Apify platform
9-
'(?:[Tt]he\s)?[Aa]pify\sproxy': Apify Proxy
7+
# Product name changes
8+
'apify dashboard': Apify Console
9+
'apify console': Apify Console
10+
'Apify console': Apify Console
11+
'apify store': Apify Store
12+
'Apify store': Apify Store
13+
14+
# Capitalization fixes
15+
'apify freelancers': Apify freelancers
16+
'apify platform': Apify platform
17+
18+
# Proxy variations (simplified)
19+
'apify proxy': Apify Proxy
20+
'the apify proxy': Apify Proxy
21+
22+
# Common abbreviations
1023
circa: approx.
24+
'ca\.': circa

.github/styles/Apify/Capitalization.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ extends: substitution
22
message: "Use '%s' instead of '%s'."
33
ignorecase: false
44
level: error
5-
scope: text & ~alt
65
nonword: true
6+
scope: text,~alt,~code
77
swap:
88
'\bactor\b': Actor
99
'\bactors\b': Actors

.github/styles/config/vocabularies/Docs/accept.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ node_modules
1616
SDK
1717
Dockerfile
1818
Docker's
19+
CAPTCHAs
1920

2021
Docusaurus
2122
navbar
@@ -53,7 +54,6 @@ proxied
5354
LLM
5455
embedder
5556
chatbot
56-
[Ll]angchain
5757

5858
[Kk]eboola
5959
[Aa]irbyte
@@ -68,7 +68,7 @@ exploitability
6868
[Ww]hitepaper
6969
[Cc]ron
7070
scalably
71-
metamorph
71+
[Mm]etamorph
7272
hostname
7373
IPs
7474
unscoped
@@ -90,8 +90,8 @@ preconfigured
9090
devs
9191
asyncio
9292
backlinks?
93-
captchas?
94-
Chatbot
93+
94+
9595
combinator
9696
deduplicating
9797
dev

.vale.ini

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ Microsoft.Auto = NO
3030
Microsoft.URLFormat = NO
3131
Microsoft.GeneralURL = NO
3232
Microsoft.RangeFormat = NO
33-
Apify.Apify = NO
34-
Apify.Languages = NO
3533

3634
[{README.md,CONTRIBUTING.md}]
3735
Apify.H1 = NO

sources/platform/actors/development/deployment/source_types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This section explains the various sources types available for Apify Actors and h
2323

2424
This is the default option when your Actor's source code is hosted on the Apify platform. It offers quick previews and updates to your source code, easy file and directory browsing, and direct testing of the [`INPUT_SCHEMA.json`](/platform/actors/development/actor-definition/input-schema) on the Apify platform.
2525

26-
A `Dockerfile` is mandatory for all Actors. When using the default NodeJS Dockerfile, you'll typically need `main.js` for your source code and `package.json` for [NPM](https://www.npmjs.com/) package configurations.
26+
A `Dockerfile` is mandatory for all Actors. When using the default NodeJS Dockerfile, you'll typically need `main.js` for your source code and `package.json` for [npm](https://www.npmjs.com/) package configurations.
2727

2828
For more information on creating custom Dockerfiles or using Apify's base images, refer to the [Dockerfile](/platform/actors/development/actor-definition/dockerfile#custom-dockerfile) and [base Docker images](/platform/actors/development/actor-definition/dockerfile#base-docker-images) documentation.
2929

sources/platform/actors/development/programming_interface/environment_variables.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,13 @@ import TabItem from '@theme/TabItem';
1717

1818
You can set up environment variables for your Actor in two ways:
1919

20+
- [How to use environment variables in an Actor](#how-to-use-environment-variables-in-an-actor)
21+
- [System environment variables](#system-environment-variables)
2022
- [Set up environment variables in `actor.json`](#set-up-environment-variables-in-actorjson)
2123
- [Set up environment variables in Apify Console](#set-up-environment-variables-in-apify-console)
24+
- [Access environment variables](#access-environment-variables)
25+
- [Use the `Configuration` class](#use-the-configuration-class)
26+
- [Build-time environment variables](#build-time-environment-variables)
2227

2328
:::info Environment variable precedence
2429

@@ -65,7 +70,7 @@ Here's a table of key system environment variables:
6570
| `ACTOR_WEB_SERVER_PORT` | TCP port for the Actor to start an HTTP server on. This server can be used to receive external messages or expose monitoring and control interfaces. The server also receives messages from the [Actor Standby](/platform/actors/development/programming-interface/standby) mode. |
6671
| `ACTOR_WEB_SERVER_URL` | Unique public URL for accessing the Actor run web server from the outside world. |
6772
| `APIFY_API_PUBLIC_BASE_URL` | Public URL of the Apify API. May be used to interact with the platform programmatically. Typically set to `api.apify.com`. |
68-
| `APIFY_DEDICATED_CPUS` | Number of CPU cores reserved for the actor, based on allocated memory. |
73+
| `APIFY_DEDICATED_CPUS` | Number of CPU cores reserved for the Actor, based on allocated memory. |
6974
| `APIFY_WORKFLOW_KEY` | Identifier used for grouping related runs and API calls together. |
7075
| `APIFY_META_ORIGIN` | Specifies how an Actor run was started. Possible values are in [Runs and builds](/platform/actors/running/runs-and-builds#origin) documentation. |
7176
| `APIFY_INPUT_SECRETS_KEY_FILE` | Path to the secret key used to decrypt [Secret inputs](/platform/actors/development/actor-definition/input-schema/secret-input). |

sources/platform/actors/development/programming_interface/metamorph.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Metamorph is a powerful operation that transforms an Actor run into the run of a
1818

1919
## Understand metamorph
2020

21-
The metamorph process involves several key steps. It stops the current Actor's Docker container, then starts a new container using a different Docker image. During this transition, all default storages are preserved. The new input is stored under the _INPUT-METAMORPH-1_ key in the default key-value store, ensuring seamless data transfer between Actor runs.
21+
The metamorph process involves several key steps. It stops the current Actor's Docker container, then starts a new container using a different Docker image. During this transition, all default storages are preserved. The new input is stored under the `INPUT-METAMORPH-1` key in the default key-value store, ensuring seamless data transfer between Actor runs.
2222

2323
## Benefits of metamorph
2424

sources/platform/actors/development/quick_start/start_locally.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,12 @@ In the next step, we’ll explore the results in more detail.
8484
### Step 3: Explore the Actor
8585
8686
Let's explore the Actor structure.
87-
87+
<!-- vale Apify.Capitalization = NO -->
8888
#### The `.actor` folder
8989
90+
9091
The `.actor` folder contains the Actor configuration. The `actor.json` file defines the Actor's name, description, and other settings. Find more info in the [actor.json](https://docs.apify.com/platform/actors/development/actor-definition/actor-json) definition.
92+
<!-- vale Apify.Capitalization = YES -->
9193
9294
#### Actor's `input`
9395

sources/platform/actors/running/tasks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sidebar_label: Tasks
1010

1111
---
1212

13-
Actor tasks let you create multiple reusable configurations of a single Actor, adapted for specific use cases. For example, you can create one [_Web Scraper_](https://apify.com/apify/web-scraper) configuration (task) that scrapes the latest reviews from imdb.com, another that scrapes nike.com for the latest sneakers, and a third that scrapes your competitor's e-shop. You can then use and reuse these configurations directly from [Apify Console](https://console.apify.com/actors/tasks), [Schedules](../../schedules.md), or [API](/api/v2/actor-task-runs-post).
13+
Actor tasks let you create multiple reusable configurations of a single Actor, adapted for specific use cases. For example, you can create one [_Web Scraper_](https://apify.com/apify/web-scraper) configuration (task) that scrapes the latest reviews from [IMDb](https://www.imdb.com/), another that scrapes nike.com for the latest sneakers, and a third that scrapes your competitor's e-shop. You can then use and reuse these configurations directly from [Apify Console](https://console.apify.com/actors/tasks), [Schedules](../../schedules.md), or [API](/api/v2/actor-task-runs-post).
1414

1515
You can find all your tasks in the [Apify Console](https://console.apify.com/actors/tasks).
1616

sources/platform/integrations/ai/mcp.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Here are some special MCP operations and how the Apify MCP Server supports them:
167167
### Overview of available tools
168168

169169
Here is an overview list of all the tools provided by the Apify MCP Server.
170-
170+
<!-- vale off -->
171171
| Tool name | Category | Enabled by default | Description |
172172
| :--- | :--- | :--- | :---: |
173173
| `search-actors` | actors || Search for Actors in the Apify Store. |
@@ -188,6 +188,7 @@ Here is an overview list of all the tools provided by the Apify MCP Server.
188188
| `get-dataset-list` | storage | | List all available datasets for the user. |
189189
| `get-key-value-store-list`| storage | | List all available key-value stores for the user. |
190190
| `add-actor` | experimental | | Add an Actor as a new tool for the user to call. |
191+
<!-- vale on -->
191192

192193
### Tools configuration
193194

0 commit comments

Comments
 (0)