Skip to content

Commit dbe2f03

Browse files
authored
docs: bring back vale rules (#1930)
rework Capitalization rules turn it back on
1 parent a5e73b2 commit dbe2f03

File tree

14 files changed

+44
-30
lines changed

14 files changed

+44
-30
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 store': Apify Store
11+
'the apify console': Apify Console
12+
'the 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
Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
extends: existence
2-
message: "The word '%s' should always be capitalized."
1+
extends: substitution
2+
message: "Use '%s' instead of '%s'."
33
ignorecase: false
44
level: error
5-
tokens:
6-
- '\bactor\b'
7-
- '\bactors\b'
5+
nonword: true
6+
scope: text,~alt,~code
7+
swap:
8+
'\bactor\b': Actor
9+
'\bactors\b': Actors

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

Lines changed: 4 additions & 3 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
@@ -67,7 +68,7 @@ exploitability
6768
[Ww]hitepaper
6869
[Cc]ron
6970
scalably
70-
metamorph
71+
[Mm]etamorph
7172
hostname
7273
IPs
7374
unscoped
@@ -89,8 +90,8 @@ preconfigured
8990
devs
9091
asyncio
9192
backlinks?
92-
captchas?
93-
Chatbot
93+
94+
9495
combinator
9596
deduplicating
9697
dev

.vale.ini

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
StylesPath = .github/styles
22
MinAlertLevel = warning
3-
IgnoredScopes = code, tt, table, tr, td, frontmatter, link, alt
3+
IgnoredScopes = code, tt, table, tr, td, frontmatter, link, alt, heading
44

55
Vocab = Docs
66

@@ -12,7 +12,7 @@ mdx = md
1212
[*.md]
1313
BasedOnStyles = Vale, Apify, write-good, Microsoft
1414
# Ignore URLs, HTML/XML tags, lines with =, emails, curly braces, inline code
15-
TokenIgnores = (<\/?[A-Z][^>]*>), ([^\n]+=[^\n]*), ([^\n]+@[^\n]+\.[^\n]), ({[^}]*})
15+
TokenIgnores = (<\/?[A-Z][^>]*>), ([^\n]+@[^\n]+\.[^\n]), ({[^}]*})
1616
# Ignore HTML comments and Markdown code blocks
1717
BlockIgnores = (?s) (<!--.*?-->)|(```.*?```)
1818

@@ -25,14 +25,9 @@ Microsoft.Contractions = NO
2525
Microsoft.Foreign = NO
2626
Microsoft.We = NO
2727
Microsoft.Quotes = NO
28-
Microsoft.ThereIs = NO
2928
Microsoft.Auto = NO
3029
Microsoft.URLFormat = NO
3130
Microsoft.GeneralURL = NO
32-
Microsoft.RangeFormat = NO
33-
Apify.Apify = NO
34-
Apify.Capitalization = NO
35-
Apify.Languages = NO
3631

3732
[{README.md,CONTRIBUTING.md}]
3833
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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Here's a table of key system environment variables:
6565
| `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. |
6666
| `ACTOR_WEB_SERVER_URL` | Unique public URL for accessing the Actor run web server from the outside world. |
6767
| `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. |
68+
| `APIFY_DEDICATED_CPUS` | Number of CPU cores reserved for the Actor, based on allocated memory. |
6969
| `APIFY_WORKFLOW_KEY` | Identifier used for grouping related runs and API calls together. |
7070
| `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. |
7171
| `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/workflows-and-notifications/bubble.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ Use this URL as the Apify webhook target. Configure the webhook's authentication
205205
1. Notify Bubble when the run finishes
206206
- Create an Apify **Webhook** with event `ACTOR.RUN.SUCCEEDED`.
207207
- Set `actorId` from the Step 1 result.
208-
- Set `databaseId` from the Step 1 result, where actor will store the result.
208+
- Set `databaseId` from the Step 1 result, where Actor will store the result.
209209
- Set `idempotencyKey` to random value.
210210
- Set `requestUrl` to your Bubble backend workflow URL, for example: `https://your-app.bubbleapps.io/version-test/api/1.1/wf/webhook`.
211211
- ![Create a webhook](../images/bubble/step2_scraping.png)

0 commit comments

Comments
 (0)