-
Notifications
You must be signed in to change notification settings - Fork 130
docs: bring back vale rules #1930
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
Changes from 5 commits
d200058
cbbc894
5938e02
7250fdf
e909c6c
cc6c41f
93a8e00
82f3e5b
df90bb6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,24 @@ | ||
extends: substitution | ||
message: "Use '%s' instead of '%s'." | ||
ignorecase: false | ||
ignorecase: true | ||
level: warning | ||
scope: text | ||
swap: | ||
Apify Dashboard: Apify Console | ||
apify freelancers: Apify freelancers | ||
Apify Platform: Apify platform | ||
'(?:[Tt]he\s)?[Aa]pify\sproxy': Apify Proxy | ||
# Product name changes | ||
'apify dashboard': Apify Console | ||
'apify console': Apify Console | ||
'Apify console': Apify Console | ||
'apify store': Apify Store | ||
'Apify store': Apify Store | ||
|
||
# Capitalization fixes | ||
'apify freelancers': Apify freelancers | ||
'apify platform': Apify platform | ||
|
||
# Proxy variations (simplified) | ||
'apify proxy': Apify Proxy | ||
'the apify proxy': Apify Proxy | ||
|
||
# Common abbreviations | ||
circa: approx. | ||
'ca\.': circa |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,9 @@ | ||
extends: existence | ||
message: "The word '%s' should always be capitalized." | ||
extends: substitution | ||
message: "Use '%s' instead of '%s'." | ||
ignorecase: false | ||
level: error | ||
tokens: | ||
- '\bactor\b' | ||
- '\bactors\b' | ||
nonword: true | ||
scope: text,~alt,~code | ||
swap: | ||
'\bactor\b': Actor | ||
'\bactors\b': Actors |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,7 +23,7 @@ This section explains the various sources types available for Apify Actors and h | |
|
||
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. | ||
|
||
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. | ||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would it make sense to add There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I want to try one more package once I deal with those rules and another PR with fixes to almost everything except H1's in Academy called Openly. I think it deals with a lot of those tech terms, might even lead to simplifying |
||
|
||
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. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,8 +17,13 @@ import TabItem from '@theme/TabItem'; | |
|
||
You can set up environment variables for your Actor in two ways: | ||
|
||
- [How to use environment variables in an Actor](#how-to-use-environment-variables-in-an-actor) | ||
- [System environment variables](#system-environment-variables) | ||
- [Set up environment variables in `actor.json`](#set-up-environment-variables-in-actorjson) | ||
- [Set up environment variables in Apify Console](#set-up-environment-variables-in-apify-console) | ||
- [Access environment variables](#access-environment-variables) | ||
- [Use the `Configuration` class](#use-the-configuration-class) | ||
- [Build-time environment variables](#build-time-environment-variables) | ||
|
||
|
||
:::info Environment variable precedence | ||
|
||
|
@@ -65,7 +70,7 @@ Here's a table of key system environment variables: | |
| `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. | | ||
| `ACTOR_WEB_SERVER_URL` | Unique public URL for accessing the Actor run web server from the outside world. | | ||
| `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`. | | ||
| `APIFY_DEDICATED_CPUS` | Number of CPU cores reserved for the actor, based on allocated memory. | | ||
| `APIFY_DEDICATED_CPUS` | Number of CPU cores reserved for the Actor, based on allocated memory. | | ||
| `APIFY_WORKFLOW_KEY` | Identifier used for grouping related runs and API calls together. | | ||
| `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. | | ||
| `APIFY_INPUT_SECRETS_KEY_FILE` | Path to the secret key used to decrypt [Secret inputs](/platform/actors/development/actor-definition/input-schema/secret-input). | | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -84,10 +84,12 @@ In the next step, we’ll explore the results in more detail. | |
### Step 3: Explore the Actor | ||
|
||
Let's explore the Actor structure. | ||
|
||
<!-- vale Apify.Capitalization = NO --> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I imagine there are multiple occurrences (or multiple occurrences can happen) of the But it's true that it doesn't solve There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. technically Vale should ignore prose in inline code done with backticks and for the 95% it does... until it doesn't thus this ugly hack There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. and even more so, it should ignore things in headings... but for some god forsaken reason it didn't here |
||
#### The `.actor` folder | ||
|
||
|
||
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. | ||
<!-- vale Apify.Capitalization = YES --> | ||
|
||
#### Actor's `input` | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If there's
ignorecase: true
, is there a reason to have both cases mentioned?Also, similar to
the apify proxy
below, we could havethe apify console
andthe apify store
swapped for just Apify Console/Store.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess that's true, I was trying to be a little extra, will remove i, and add your suggestion