Skip to content
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

use Vale to fix small typos and spelling errors #401

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/docs/databases/bring-your-own-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ width={700} height={225} quality={100} />

## Template Marketplace

Need inspiration? Our [Template Marketplace](https://railway.app/templates) already includes solutions for many different database services. You might even find find a template for the database you need!
Need inspiration? Our [Template Marketplace](https://railway.app/templates) already includes solutions for many different database services. You might even find a template for the database you need!

Here are some suggestions to checkout -
- [Minio](https://railway.app/template/SMKOEA)
Expand Down
4 changes: 2 additions & 2 deletions src/docs/databases/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To access your MySQL database over the public internet, you can use the connecti

This connection string uses the [TCP Proxy connection](/deploy/exposing-your-app#tcp-proxying) to route communication to your service over the public internet.

You can also connect using mysql shell:
You can also connect using MySQL shell:
```bash
mysql -h PUBLIC_DOMAIN -P PUBLIC_PORT -u root -p
```
Expand All @@ -62,4 +62,4 @@ The MySQL database service uses the [mysql:latest](https://hub.docker.com/_/mysq

## Changing System Variables

Tailor your MySQL service to your needs by adding any variables relevant to the [mysql](https://hub.docker.com/_/mysql) image.
Tailor your MySQL service to your needs by adding any variables relevant to the [MySQL](https://hub.docker.com/_/mysql) image.
7 changes: 3 additions & 4 deletions src/docs/databases/postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To access your PostgreSQL database over the public internet, you can use the con

This connection string uses the [TCP Proxy connection](/deploy/exposing-your-app#tcp-proxying) to route communication to your service over the public internet.

You can also connect using psql shell:
You can also connect using `psql` shell:
```bash
psql "postgres://railway:PASSWORD@PROXY_DOMAIN:PROXY_PORT/railway"
```
Expand All @@ -58,12 +58,11 @@ it to connect to PostgreSQL but you can use these variables in whatever way work

## Image

The Postgres database service uses Railway's [SSL-enabled Postgres image](https://github.com/railwayapp-templates/postgres-ssl/pkgs/container/postgres-ssl), which uses the official [postgres](https://hub.docker.com/_/postgres) image in Docker Hub as its base.
The Postgres database service uses Railway's [SSL-enabled Postgres image](https://github.com/railwayapp-templates/postgres-ssl/pkgs/container/postgres-ssl), which uses the official [Postgres](https://hub.docker.com/_/postgres) image in Docker Hub as its base.

## Changing System Variables

Tailor your PostgreSQL service to your needs by adding any variables relevant to the [postgres](https://hub.docker.com/_/postgres) image.

Tailor your PostgreSQL service to your needs by adding any variables relevant to the [Postgres](https://hub.docker.com/_/postgres) image.

## Timescale and PostGIS

Expand Down
6 changes: 3 additions & 3 deletions src/docs/deploy/builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ _Note, negations will only work if you include files in a preceding rule._

<PriorityBoardingBanner />

With Nixpacks, we analyze the app source directory and generate a build plan. This determines which language provider to install packages and runtimes for.
With Nixpacks, we analyze the app source directory and generate a build plan. This determines which language provider to install and the required packages and runtimes.

If there is a detected `nixpacks.toml` file, it is possible to define a build provider ahead of time like so:
```toml
Expand All @@ -136,7 +136,7 @@ HTTP servers should use the `web` process type. This process should listen on
the [PORT environment variable](/deploy/railway-up#port-variable) and will receive
HTTP traffic.

_Note: some buildpacks specify a default start command_
_Note: some Buildpacks specify a default start command_

## Dockerfiles

Expand All @@ -146,4 +146,4 @@ We will also build using a [Dockerfile](/deploy/dockerfiles) if found at the pro

### How to specify a custom install command?

We do not expose a way to configure a custom install command in the UI, but you can control this using [config as code](/deploy/config-as-code#install-command). See Nixpacks Plan > Install Command.
We do not expose a way to configure a custom install command in the UI, but you can control this using [config as code](/deploy/config-as-code#install-command). See Nixpacks Plan > Install Command.
10 changes: 5 additions & 5 deletions src/docs/deploy/config-as-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ dashboard.

These configuration examples are equivalent.

### Toml
### TOML

In a `railway.toml` file:
```toml
Expand All @@ -33,7 +33,7 @@ healthcheckTimeout = 100
restartPolicyType = "never"
```

### Json
### JSON

In a `railway.json` file:
```json
Expand Down Expand Up @@ -80,7 +80,7 @@ Possible values are:
- `NIXPACKS`
- `DOCKERFILE`

Note: Railway will always build with a Dockerfile if it finds one. To build with nixpacks, you can remove or rename the Dockerfile..
Note: Railway will always build with a Dockerfile if it finds one. To build with Nixpacks, you can remove or rename the Dockerfile..

### [Watch Patterns](/deploy/builds#watch-paths)

Expand Down Expand Up @@ -126,7 +126,7 @@ This field can be set to `null`.

### Nixpacks Plan

Full nixpacks plan. See https://nixpacks.com/docs/configuration/file for more info.
Full Nixpacks plan. See https://nixpacks.com/docs/configuration/file for more info.

```toml
[build]
Expand Down Expand Up @@ -290,7 +290,7 @@ In a `railway.json` file:

Deployments for pull requests can be configured using a special `pr` environment. This configuration is applied only to deploys that belong to an ephemeral environment. When resolving the settings for a PR deployment, the following priority order is used:
1. Environment with the name of the ephemeral environment
2. Environment with the hardcoded name "pr"
2. Environment with the hardcoded name `pr`
3. Base environment of the pull request
4. Base config as code
5. Service settings
Expand Down
6 changes: 3 additions & 3 deletions src/docs/deploy/deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,14 @@ When enabled, deployments will be moved to a `WAITING` state while your workflow
A start command is the process used to run a Deployment's code. For example, a Python project may have a start command of `python main.py`, or a NodeJS project may have a start command of `npm run start`.

Railway automatically configures the start command based on the code being
deployed. If your code uses a Dockerfile, the start command defaults to the ENTRYPOINT and/or CMD defined in the Dockerfile. Otherwise, the buildpack used to create the image will determine the start command - see [Builds](builds) for more details.
deployed. If your code uses a Dockerfile, the start command defaults to the ENTRYPOINT and/or CMD defined in the Dockerfile. Otherwise, the Buildpack used to create the image will determine the start command - see [Builds](builds) for more details.

Start commands may be overridden for advanced use-cases such as
deploying multiple projects from a single [monorepo](/deploy/monorepo).

When specifying a start command, the behavior of the image depends on type of build:
- **Dockerfile**: the start command overrides the Docker image's ENTRYPOINT in [exec form](https://docs.docker.com/engine/reference/builder/#exec-form-entrypoint-example)
- **Buildpack**: the start command is inserted as a [buildpack launch process](https://buildpacks.io/docs/app-developer-guide/run-an-app/#user-provided-shell-process)
- **Buildpack**: the start command is inserted as a [Buildpack launch process](https://buildpacks.io/docs/app-developer-guide/run-an-app/#user-provided-shell-process)

<Image
src="https://res.cloudinary.com/railway/image/upload/v1637798815/docs/custom-start-command_a8vcxs.png"
Expand Down Expand Up @@ -130,7 +130,7 @@ deployment in progress.

### Remove

If a deployment is completed, you can remove it by clicking the the three dots
If a deployment is completed, you can remove it by clicking the three dots
at the end of the deployment tab and select Remove. This will remove the
deployment and stop any further project usage.

Expand Down
6 changes: 3 additions & 3 deletions src/docs/deploy/exposing-your-app.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delete colons

Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ worldwide. Freenom is not allowed, and not supported.

There are a few important things to know when using Wildcard Domains:

1. Ensure that the CNAME record for authorize.railwaydns.net is not proxied by your provider (eg: Cloudflare). This is required for the verification process to work.
2. Wildcards can be used for any subdomain level (eg: `*.yourdomain.com` or `*.subdomain.yourdomain.com`).
3. You cannot nest wildcards (eg: \*.\*.yourdomain.com).
1. Ensure that the CNAME record for authorize.railwaydns.net is not proxied by your provider (e.g.: Cloudflare). This is required for the verification process to work.
2. Wildcards can be used for any subdomain level (e.g.: `*.yourdomain.com` or `*.subdomain.yourdomain.com`).
3. You cannot nest wildcards (e.g.: \*.\*.yourdomain.com).

<Image
src="https://res.cloudinary.com/railway/image/upload/v1679693511/wildcard_domains_zdguqs.png"
Expand Down
2 changes: 1 addition & 1 deletion src/docs/deploy/healthchecks.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ alt="Screenshot of Healthchecks"
layout="intrinsic"
width={876} height={434} quality={80} />

First, make sure your webserver has an endpoint (e.g. `/health`) that will return a response with HTTP status code 200 when your application is live and ready. If your application needs to do some initialization on startup (running database migrations, populating cache, etc.), it's a good idea to return a non-200 status code from your endpoint until the initialization completes.
First, make sure your web server has an endpoint (e.g. `/health`) that will return a response with HTTP status code 200 when your application is live and ready. If your application needs to do some initialization on startup (running database migrations, populating cache, etc.), it's a good idea to return a non-200 status code from your endpoint until the initialization completes.

Under Service → Settings, input your health endpoint. Railway will wait for this endpoint to serve a `200` status code before switching traffic to your new deployment.

Expand Down
2 changes: 1 addition & 1 deletion src/docs/deploy/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Logging
---

Any build or deployment logs emitted to standard output or standard error (
eg. `console.log(...)`) is captured by Railway to be viewed or searched later.
e.g. `console.log(...)`) is captured by Railway to be viewed or searched later.

Depending on your plan, logs are retained for a certain amount of time.

Expand Down
8 changes: 4 additions & 4 deletions src/docs/deploy/monorepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ of common code between them.
Railway provides a few features to help improve support for deploying monorepos
of various types:
1. **[Isolated Monorepo](#isolated-monorepo)** → A repository that contains components that are completely isolated to the
directory they are contained in (eg. JS frontend and Python backend)
directory they are contained in (e.g. JS frontend and Python backend)
2. **[Shared Monorepo](#shared-monorepo)** → A repository that contains components that share code or configuration from the
root directory (eg. Yarn workspace or Lerna project)
root directory (e.g. Yarn workspace or Lerna project)

## Isolated Monorepo

Expand Down Expand Up @@ -41,10 +41,10 @@ width={980} height={380} quality={80} />
## Shared Monorepo

Popular in the JavaScript ecosystem, shared monorepos contain multiple components that all share a common root directory. By default, all components are built with
a single command from the root directory (eg. `npm run build`). However, if you are using Nixpacks, then you can override the build command in the service settings.
a single command from the root directory (e.g. `npm run build`). However, if you are using Nixpacks, then you can override the build command in the service settings.

The start command can be overridden in the Railway settings (
eg. `npm run start:backend` and `npm run start:frontend`).
e.g. `npm run start:backend` and `npm run start:frontend`).

```
├── package.json
Expand Down
2 changes: 1 addition & 1 deletion src/docs/develop/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,6 @@ railway logout

### Contributing

Our CLI is open source. Contribute to the development of the Railway CLI by opening an issue or Pull Request on our [GitHub Repo](https://github.com/railwayapp/cli).
Our CLI is open source. Contribute to the development of the Railway CLI by opening an issue or Pull Request on our [GitHub repo](https://github.com/railwayapp/cli).

[You can see the full documentation of the CLI API here.](/reference/cli-api)
4 changes: 2 additions & 2 deletions src/docs/develop/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ alt="Screenshot of replica setting"
layout="responsive"
width={800} height={317} quality={100} />

By default Railway will scale your service up to the the specified vCPU and Memory limits of your plan. You can scale horizontally by manually increasing the number of replicas for a service.
By default Railway will scale your service up to the specified vCPU and Memory limits of your plan. You can scale horizontally by manually increasing the number of replicas for a service.

To change the number of replicas per deploy within your service, go to the service settings view and look for the "Replicas" field in the "Deploy" section. This will create multiple instances of your service and distribute traffic between them.

Expand Down Expand Up @@ -116,7 +116,7 @@ Railway has a user interface for managing your database service's data. You can

## Templates

Railway offers 200+ [community-maintained templates](https://railway.app/templates). A template with a Github repo will clone the repo to your account, and deploy the service(s) to a project. A template with Docker images will deploy the images directly. You can deploy a template from the Project Canvas unless there are variables to configure. To configure environment variables, you'll need to use the New Project button. Templates are useful for deploying common pieces of infrastructure — like a DataDog Agent.
Railway offers 200+ [community-maintained templates](https://railway.app/templates). A template with a GitHub repo will clone the repo to your account, and deploy the service(s) to a project. A template with Docker images will deploy the images directly. You can deploy a template from the Project Canvas unless there are variables to configure. To configure environment variables, you'll need to use the New Project button. Templates are useful for deploying common pieces of infrastructure — like a Datadog Agent.

## Empty Application Services

Expand Down
6 changes: 2 additions & 4 deletions src/docs/develop/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,12 @@ Here are some example scenarios to help clarify reference variable usage and syn
- `API_KEY=${{shared.API_KEY}}`

#### Referencing another service's variables
- You have a variable set on your database service called `DATABASE_URL` which contains the connection string to connect to the database. The database service name is **Clickhouse**.
- You have a variable set on your database service called `DATABASE_URL` which contains the connection string to connect to the database. The database service name is **ClickHouse**.

You need to make this connection string available to another service in the project. Go to the service's variables that needs the connection string and add a variable with the following value:
- `DATABASE_URL=${{ Clickhouse.DATABASE_URL }}`

- Your frontend service needs to make requests to your backend. You do not want to hardcode the backend URL in your frontend code. Go to your frontend service settings and add the [Railway-provided variable](/develop/variables#railway-provided-variables) for the backend URL -
- Your frontend service needs to make requests to your backend. You don't want to hardcode the backend URL in your frontend code. Go to your frontend service settings and add the [Railway-provided variable](/develop/variables#railway-provided-variables) for the backend URL -
- `API_URL=https://${{ backend.RAILWAY_PUBLIC_DOMAIN }}`

#### Referencing variables in the same service
Expand All @@ -108,8 +108,6 @@ GRAPHQL_ENDPOINT=https://${{DOMAIN}}/${{GRAPHQL_PATH}}

The example above illustrates a pattern of maintaining a Shared variable called `DOMAIN` and using that plus a Service variable to construct an endpoint.



## Using Variables in your services

Variables are made available at runtime as environment variables. In order to use them in your code, simply use the package appropriate for your language to retrieve environment variables.
Expand Down
6 changes: 3 additions & 3 deletions src/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Begin by cloning the repo you created on your machine.

The Railway CLI connects your code to your infrastructure.

Install with [Brew](https://brew.sh), [NPM](https://www.npmjs.com/package/@railway/cli), or [Scoop](develop/cli#install):
Install with [Brew](https://brew.sh), [npm](https://www.npmjs.com/package/@railway/cli), or [Scoop](develop/cli#install):

(Note: Brew works best on M1 Macs.)

Expand Down Expand Up @@ -149,7 +149,7 @@ Open `src/pages/index.tsx` in a text editor of your choice and change line 79 of
<h1 className={styles.title}>My Todos</h1>
```

If you are running the dev server locally, you'll see the change. Feel free to change anything within the project as well! We can't stop you.
If you are running the development server locally, you'll see the change. Feel free to change anything within the project as well! We can't stop you.

Once you are done, save the file. If you're in a Git repository, you may also commit and push to your remote Git repository. In the next step, we will show you how easy it is to deploy your changes.

Expand All @@ -169,7 +169,7 @@ width={800} height={486} quality={100} />
This will create a [deployment](deploy/railway-up) using the current project and
environment. Click the returned link to see the build and deploy logs.

For projects based on a GitHub repo like a template, [auto deploys](deploy/deployments#deploy-triggers) are automatically enabled. Commits on the main branch trigger a redeploy. You can also enable ephemeral deploy environments for PRs made in GitHub Repos.
For projects based on a GitHub repo like a template, [auto deploys](deploy/deployments#deploy-triggers) are automatically enabled. Commits on the main branch trigger a redeploy. You can also enable ephemeral deploy environments for PRs made in GitHub repos.

After your deployment completes, you can see your new deployment live at the deployment's URL. If you added To-Dos while developing locally, you should see them on your deployment live. In a proper project, you would enable multiple environments to isolate your production environment.

Expand Down
2 changes: 1 addition & 1 deletion src/docs/guides/database-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ width={725} height={613} quality={80} />
Once the migration is complete, the migration service will be deleted.
4. **Update Service Variables** - [Variable references](/develop/variables#reference-variables) within services that point to the database plugin will be updated to the new database service

5. **Redeploy Connected Services** - Services previously connected to the database plugin will be redployed to apply the updated connection string and connect to the new database service.
5. **Redeploy Connected Services** - Services previously connected to the database plugin will be redeployed to apply the updated connection string and connect to the new database service.

_**NOTE: The legacy plugin will NOT be deleted automatically.**_

Expand Down
2 changes: 1 addition & 1 deletion src/docs/guides/migrate-from-heroku.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Migrate from Heroku

Migrating your app from Heroku to Railway is very simple. We even support Procfiles out of the box. (Only a single process is supported for now).

All you need to do is create a project in Railway, push your code, and migrate your envionment variables.
All you need to do is create a project in Railway, push your code, and migrate your environment variables.

This guide will step you through the process of migrating a simple web service, using the [Railway CLI](/develop/cli).

Expand Down
Loading