Skip to content

Commit f6c3334

Browse files
committed
remove typos workflow & config file
remove typos workflow & config file create extensive accept.txt that catches known exceptions add vale turn off in problematic places until better solution is found
1 parent d619faf commit f6c3334

File tree

33 files changed

+141
-100
lines changed

33 files changed

+141
-100
lines changed
Lines changed: 71 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,84 @@
1-
apify(?=-\w+)
1+
Apify(?=-\w+)
2+
@apify\.com
3+
\bApify\b
24
Actor(s)?
5+
SDK(s)
6+
[Ss]torages
7+
Crawlee
8+
[Aa]utoscaling
9+
CU
10+
311
booleans
4-
Docusaurus
512
env
13+
npm
14+
serverless
15+
[Bb]oolean
16+
node_modules
17+
[Rr]egex
18+
[Mm]onorepo
19+
[Gg]ist
20+
SDK
21+
Dockerfile
22+
Docker's
23+
24+
Docusaurus
625
navbar
726
nginx
8-
npm
27+
928
:::caution
1029
:::note
1130
:::info
1231
:::tip
1332
:::warning
14-
Apify
15-
serverless
16-
SDK(s)
17-
[Ss]torages
33+
34+
PDFs
35+
dataset's
36+
gif
37+
Gzip
38+
39+
API's
40+
APIs
41+
webhook's
42+
idempotency
43+
backoff
44+
45+
Authy
46+
reCaptcha
47+
OAuth
48+
untrusted
49+
unencrypted
50+
proxied
51+
52+
LLM
53+
embedder
54+
chatbot
55+
[Ll]angchain
56+
57+
[Kk]eboola
58+
[Aa]irbyte
59+
[Qq]drant
60+
[Pp]inecone
61+
[Mm]ilvus
62+
[Zz]illiz
63+
llama_index
64+
[Ff]lowise
65+
1866
exploitability
1967
Whitepaper
2068
[Cc]ron
21-
Crawlee
69+
scalably
70+
metamorph
71+
hostname
72+
IPs
73+
unscoped
74+
multistep
75+
[Aa]utogenerated
76+
preconfigured
77+
78+
[Ww]ikipedia
79+
[Zz]apier
80+
[Tt]rello
81+
[Pp]refill
82+
83+
84+
[Mm]ultiselect

.github/workflows/typos-check.yaml

Lines changed: 0 additions & 18 deletions
This file was deleted.

.vale.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ mdx = md
1111
[*.md]
1212
BasedOnStyles = Vale, Apify, write-good, Microsoft
1313
# Ignore URLs, HTML/XML tags starting with capital letter, lines containing = sign, http & https URL ending with ] or ) & email addresses
14-
TokenIgnores = (<\/?[A-Z].+>), ([^\n]+=[^\n]*), (http[^\n]+\)), (https[^\n]+\)), ([^\n]+@[^\n]+\.[^\n]), (http[^\n]+\]), (https[^\n]+\])
14+
TokenIgnores = (<\/?[A-Z].+>), ([^\n]+=[^\n]*), (\[[^\]]+\]\([^\)]+\)), ([^\n]+@[^\n]+\.[^\n]), ({[^}]*}), (`[^`]*`), (`\w+`)
1515
Vale.Spelling = YES
1616

1717

_typos.toml

Lines changed: 0 additions & 12 deletions
This file was deleted.

sources/platform/actors/development/actor_definition/actor_json.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug: /actors/development/actor-definition/actor-json
55
sidebar_position: 1
66
---
77

8-
**Learn how to write the main Actor config in the `.actor/actor.json` file.**
8+
**Learn how to write the main Actor configuration in the `.actor/actor.json` file.**
99

1010
---
1111

sources/platform/actors/development/actor_definition/input_schema/secret_input.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ To make an input field secret, you need to add a `"isSecret": true` setting to t
3434
```
3535

3636
The editor for this input field will then turn into a secret input, and when you edit the field value, it will be stored encrypted.
37-
37+
<!-- vale off -->
3838
<img src={require("./images/secret-input-editor.png").default} alt="Secret input editor" style={{ width: '100%', maxWidth: '822px' }}/>
39-
39+
<!-- vale on -->
4040
:::note Type restriction
4141

4242
This is only available for `string` inputs, and the editor type is limited to `textfield` or `textarea`.

sources/platform/actors/development/actor_definition/input_schema/specification.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The Actor input schema serves three main purposes:
1818
- It simplifies invoking your Actors from external systems by generating calling code and connectors for integrations.
1919

2020
To define an input schema for an Actor, set `input` field in the `.actor/actor.json` file to an input schema object (described below), or path to a JSON file containing the input schema object.
21-
For backwards compatibility, if the `input` field is omitted, the system looks for an `INPUT_SCHEMA.json` file either in the `.actor` directory or the Actor's top-level directory—but note that this functionality is deprececated and might be removed in the future. The maximum allowed size for the input schema file is 500 kB.
21+
For backwards compatibility, if the `input` field is omitted, the system looks for an `INPUT_SCHEMA.json` file either in the `.actor` directory or the Actor's top-level directory—but note that this functionality is deprecated and might be removed in the future. The maximum allowed size for the input schema file is 500 kB.
2222

2323
When you provide an input schema, the system will validate the input data passed to the Actor on start (via the API or Apify Console) against the specified schema to ensure compliance before starting the Actor.
2424
If the input object doesn't conform the schema, the caller receives an error and the Actor is not started.
@@ -343,7 +343,7 @@ The object where the proxy configuration is stored has the following structure:
343343
}
344344
```
345345

346-
Example of a blackbox object:
346+
Example of a black box object:
347347

348348
```json
349349
{

sources/platform/actors/development/builds_and_runs/builds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ slug: /actors/development/builds-and-runs/builds
1111

1212
## Understand Actor builds
1313

14-
Before an Actor can be run, it needs to be built. The build process creates a snapshot of a specific version of the Actor's settings, including its [source code](../actor_definition/source_code.md) and [environment variables](../programming_interface/environment_variables.md). This snapshot is then used to create a Docker image containing everything the Actor needs for its run, such as NPM packages, web browsers, etc.
14+
Before an Actor can be run, it needs to be built. The build process creates a snapshot of a specific version of the Actor's settings, including its [source code](../actor_definition/source_code.md) and [environment variables](../programming_interface/environment_variables.md). This snapshot is then used to create a Docker image containing everything the Actor needs for its run, such as `npm` packages, web browsers, etc.
1515

1616
### Build numbers
1717

sources/platform/actors/development/builds_and_runs/state_persistence.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Long-running [Actor](../../index.mdx) jobs may need to migrate between servers.
1818
To prevent data loss, long-running Actors should:
1919

2020
- Periodically save (persist) their state.
21-
- Listem for [migration events](/sdk/js/api/apify/class/PlatformEventManager)
21+
- Listen for [migration events](/sdk/js/api/apify/class/PlatformEventManager)
2222
- Check for persisted state when starting, allowing them to resume from where they left off.
2323

2424
For short-running Actors, the risk of restarts and the cost of repeated runs are low, so you can typically ignore state persistence.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To set up automated builds and tests for your Actors you need to:
3030
![Apify token in app](./images/ci-token.png)
3131

3232
1. Add your Apify token to GitHub secrets
33-
1. Go to your repo > Settings > Secrets > New repository secret
33+
1. Go to your repository > Settings > Secrets > New repository secret
3434
1. Name the secret & paste in your token
3535
1. Add the Builds Actor API endpoint URL to GitHub secrets
3636
1. Use this format:
@@ -43,7 +43,7 @@ To set up automated builds and tests for your Actors you need to:
4343
4444
1. Name the secret
4545
1. Create GitHub Actions workflow files:
46-
1. In your repo, create the `.github/workflows` directory
46+
1. In your repository, create the `.github/workflows` directory
4747
2. Add `latest.yml` and `beta.yml` files with the following content
4848
4949
<Tabs groupId="main">

0 commit comments

Comments
 (0)