Skip to content

Commit

Permalink
Fix a lot of common grammar mistakes (#168)
Browse files Browse the repository at this point in the history
* add a note about freenom

* fix grammar mistakes and clarify some things
  • Loading branch information
Milo123459 authored Nov 14, 2022
1 parent c60276f commit e5763f0
Show file tree
Hide file tree
Showing 23 changed files with 55 additions and 44 deletions.
9 changes: 9 additions & 0 deletions .vscode/ltex.dictionary.en-US.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Buildpacks
Nixpacks
dynos
Healthchecks
Procfiles
vCPU
Changelog
zsh
pullrequest
2 changes: 2 additions & 0 deletions .vscode/ltex.hiddenFalsePositives.en-US.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
{"rule":"MORFOLOGIK_RULE_EN_US","sentence":"^\\QAt the time, the idea of unikernels and Docker didn't take hold until much later.\\E$"}
{"rule":"NOUN_VERB_CONFUSION","sentence":"^\\QBecause we image all builds, you can rollback to an earlier working deploy in just one click.\\E$"}
6 changes: 3 additions & 3 deletions src/pages/deploy/config-as-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ alongside your code. By default, we will look for a `railway.toml` or
`railway.json` file. Everything in the build and deploy sections of the service
settings page can be specified in this configuration file.

When a new deploy is triggered, Railway will look for any config files in your
When a new deployment is triggered, Railway will look for any config files in your
code and combine these values with the settings from the dashboard. The
resulting build and deploy config will be used **only for the current deploy**.
The settings in the dashboard will not be updated with the settings defined in
Expand Down Expand Up @@ -57,7 +57,7 @@ In a `railway.json` file

## Config Source Location

On the deployment details page, all of the settings that a deploy went out with are shown. For settings that comes from a configuration file, there is a little file icon. Hovering over the icon will show exactly what part of the file the values originated from.
On the deployment details page, all the settings that a deployment went out with are shown. For settings that comes from a configuration file, there is a little file icon. Hovering over the icon will show exactly what part of the file the values originated from.

<Image
src="https://res.cloudinary.com/railway/image/upload/v1666388941/docs/details-page-config-tooltip_jvy1qu.png"
Expand Down Expand Up @@ -175,7 +175,7 @@ width={621} height={204} quality={100} />

## Environment Overrides

Configuration can be overriden for a specific environment by nesting it in an
Configuration can be overridden for a specific environment by nesting it in a
`environments.[name]` block.

When resolving the settings for a deployment, Railway will use this priority order
Expand Down
5 changes: 2 additions & 3 deletions src/pages/deploy/deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ layout="responsive"
width={1103} height={523} quality={80} />

All deployments will appear in the deployments view on your selected service.
Clicking on the deployment will bring up the build and deploy logs. Each deploy has the option to configure a
a Railway provided domain as well as attaching a custom domain.
Clicking on the deployment will bring up the build and deploy logs. Each deploy has the option to configure a Railway provided domain as well as attaching a custom domain.

## Deployment Lifecycle

Expand Down Expand Up @@ -48,7 +47,7 @@ variable under the Variables page in your project. For more information, see [Ex

## Deploy Triggers

A new deploy is triggered when the [command](/deploy/railway-up) `railway up` is
A new deployment is triggered when the [command](/deploy/railway-up) `railway up` is
executed. [GitHub Services](/develop/services#github-services) that are linked to a GitHub repo automatically deploy when
new commits are detected in the connected branch.

Expand Down
2 changes: 2 additions & 0 deletions src/pages/deploy/exposing-your-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ width={1338} height={808} quality={80} />
**NOTE!:** Changes to DNS settings may take up to 72 hours to propagate
worldwide.

**NOTE:**: freenom is not allowed, and not supported.

## Let's Encrypt SSL Certificates

Once a custom domain has been correctly configured, Railway will automatically
Expand Down
2 changes: 1 addition & 1 deletion src/pages/develop/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: CLI
---

<Image src="https://res.cloudinary.com/railway/image/upload/v1645060494/docs/CLIexample_fiflvb.gif"
alt="Gif of the CLI in Action"
alt="GIF of the CLI in Action"
layout="intrinsic"
width={800} height={468} quality={100} />

Expand Down
4 changes: 2 additions & 2 deletions src/pages/develop/environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ Deploys are also scoped to a specific Railway environment. When you create a [Gi

You can create an environment under Settings > Environments. When you create an environment, Railway provisions the same services from the `production` environment.

<Image src="https://res.cloudinary.com/railway/image/upload/v1644621886/docs/Environments.gif"
<Image src="https://res.cloudinary.com/railway/image/upload/v1644621886/docs/Environments.gif"
alt="Screenshot of Environments Page"
layout="responsive"
width={800} height={434} quality={100} />

## Environment Deploys

Running `railway up` with an environment selected from the CLI will create a deploy using the variables from the Environment.
Running `railway up` with an environment selected from the CLI will create a deployment using the variables from the Environment.

## Ephemeral Environments

Expand Down
4 changes: 2 additions & 2 deletions src/pages/develop/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Projects
---

<Image src="https://res.cloudinary.com/railway/image/upload/v1645132880/docs/project-page_ihrmaq.png"
alt="Gif of the CLI in Action"
alt="GIF of the CLI in Action"
layout="intrinsic"
width={779} height={442} quality={100} />

Expand Down Expand Up @@ -56,7 +56,7 @@ Under the Members tab, you can invite members to access the project.
There are three scopes for project members

- Owner: full administration of the project
- Editor: adminstration and can make deployments to the project, sans the ability to remove the Owner from the project
- Editor: administration and can make deployments to the project, sans the ability to remove the Owner from the project
- Viewer: Read only access to the project. Viewers can not make deploys or see environment variables.

Only project owners are charged for project usage.
Expand Down
8 changes: 4 additions & 4 deletions src/pages/develop/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Services
---

<Image src="https://res.cloudinary.com/railway/image/upload/v1656640995/docs/CleanShot_2022-06-30_at_18.17.31_cl0wlr.gif"
alt="Gif of the Services view"
alt="GIF of the Services view"
layout="intrinsic"
width={800} height={646} quality={100} />

Expand All @@ -12,7 +12,7 @@ A railway service is a deployment target for your application. There are two typ
- Persistent database services
- Ephemeral deployment services

Deployment services can be connected to a GitHub repo and autodeployed on each commit. Templates are a pre-configured groups of services that can be used as a starting off point for your project, or added to an existing project).
Deployment services can be connected to a GitHub repo and automatically deployed on each commit. Templates are a pre-configured group of services that can be used as a starting off point for your project, or added to an existing project.

Services keep track of all current and historical deployment attempts as well as [variables](/develop/variables), [metrics](/diagnose/metrics), and application source like a GitHub repo and a start command. Clicking a service within the project canvas will bring up the service view on the side of your browser.

Expand All @@ -26,7 +26,7 @@ Anytime within a project, a new service can be created with the command palette.

## Deployment Services

Application services are services which tie to a GitHub repo as the source of deployment. Railway will clone into the root directory of the provided repo and initiate a [deploy](/deploy/deployments). We will then use a Cloudnative buildback to automagically determine the application runtime and begin hosting it.
Application services are services which tie to a GitHub repo as the source of deployment. Railway will clone into the root directory of the provided repo and initiate a [deployment](/deploy/deployments). We will then use a Cloudnative buildback to automagically determine the application runtime and begin hosting it.

### Monorepo Services

Expand Down Expand Up @@ -79,4 +79,4 @@ You can delete your service by opening the project's settings and navigating to

## Service Icons

Within the Command Palette, you can change the default service icon to something else. The list of available icons are pulled from our [devicons](https://devicons.railway.app/) service.
Within the Command Palette, you can change the default service icon to something else. The list of available icons is pulled from our [devicons](https://devicons.railway.app/) service.
2 changes: 1 addition & 1 deletion src/pages/diagnose/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ alt="Screenshot of Metric Timeseries Commit Information"
layout="responsive"
width={904} height={726} quality={80} />

Your project maintains a continuous timeseries for all your deployments within a service, not just the latest one. Deployments appear on the graph so you can see which commit may have caused a spike in resources.
Your project maintains a continuous timeseries for all your deployments within a service, not just the latest one. Deployments appear on the graph, so you can see which commit may have caused a spike in resources.
2 changes: 1 addition & 1 deletion src/pages/diagnose/project-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ On the starter plan, it will show the remaining usage balance you have.

### Billing Alerts

Throughout the month as your usage increases, we will send you an email reminding you how much usage you have used, and if you are on the Starter plan, how much usage you have remaining.
Throughout the month as your usage increases, we will email you reminding you how much usage you have used, and if you are on the Starter plan, how much usage you have remaining.
4 changes: 2 additions & 2 deletions src/pages/diagnose/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Complete the following steps to setup a webhook:
4. Input your desired webhook URL into the input under "Build and Deploy Webhooks".
5. Click the checkmark to the right of the input to save.

The URL you provide will receive a webhook payload when the current project's deploy status changes. This will be executed across all environments in the project.
The URL you provide will receive a webhook payload when the current project's deployment status changes. This will be executed across all environments in the project.

To see what payload will be transmitted to the URL, you can expand the "Example webhook payload" panel.

Expand Down Expand Up @@ -47,7 +47,7 @@ Discord supports integrating directly with webhooks. To enable this on a server

At this point, the Discord Muxer will identify the URL and change the payload to accommodate the Discord integration. You can see this if you expand the payload preview panel.

You are now done! When your project deploys again, that Discord channel will get updates on the deploy!
You are now done! When your project deploys again, that Discord channel will get updates on the deployment!

## Setting up a webhook for Slack

Expand Down
2 changes: 1 addition & 1 deletion src/pages/reference/accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The main account preferences page is accessible by clicking your profile photo i

### Change Account Information

Accounts can change their display name, profile photo, and account email under the main account
Accounts can change their display name, profile photo, and account email under [Account Settings](https://railway.app/account).

### Deleting Your Account

Expand Down
4 changes: 2 additions & 2 deletions src/pages/reference/cli-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Run `railway completion --help` to for information on how to install the complet

## Connect

Lets you connect to your Railway plugins.
Open an interactive shell for one of your databases.

```bash
railway connect [plugin]
Expand All @@ -38,7 +38,7 @@ Supported:

## Docs

Open the Railway documentation (this website) in the default browser
Open the Railway documentation (this website) in the default browser.

```bash
railway docs
Expand Down
4 changes: 2 additions & 2 deletions src/pages/reference/compare-to-heroku.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ One prevalent option is Heroku. Heroku became known for one of the easiest ways
Railway is a natural replacement for people looking to move on from Heroku or looking for similar alternatives.

However, one of the most common questions we receive is: How are we different or better than Heroku?
We owe a lot to the pioneers that were the founders of Heroku. However, in 2007, Heroku's founding, the state of cloud deployments was much different than what they were today. As a result, their product reflects the context of the state of the cloud was then.
We owe a lot to the pioneers that were the founders of Heroku. However, in 2007, Heroku's founding, the state of cloud deployments was much different from what they were today. As a result, their product reflects the context of the state of the cloud was then.

## Differences

Expand Down Expand Up @@ -88,6 +88,6 @@ Getting your app hosted on Heroku moved over to Railway is very simple.

All you need to do is connect your GitHub account, create a new project, and then deploy your repo. We even support Procfiles out of the box. (Caveat: only a single process is supported for now)

If you wanna learn in-depth about our product and the feature discussed here, we have a Getting Started guide.
If you want to learn in-depth about our product and the feature discussed here, we have a Getting Started guide.

If you run into any issues, we would be more than happy to answer your questions on our [Discord](https://discord.gg/railway) or over email at contact (at) railway (dot) app
3 changes: 1 addition & 2 deletions src/pages/reference/guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Guides
---

The Railway Team and the community provides content on how to make the most out of Railway. Consider this page as a list for all of the awesome tutorials that help you achieve what you aim to do.
The Railway Team and the community provides content on how to make the most out of Railway. Consider this page as a list for all the awesome tutorials that help you achieve what you aim to do.

We have attempted to group these guides by category. Pull requests are welcome if you make a quality tutorial for other Railway users, we would love to include it!

Expand All @@ -21,7 +21,6 @@ These are guides centered around deploying cool projects up on Railway.
- [Getting Started (with NextJS Prisma)](/getting-started)

## Database Backup Guides
Guides for helping you manage your plugin's data.

- [Backing Up Redis](https://blog.railway.app/p/redis-backup)
- [Backing Up Postgres](https://blog.railway.app/p/postgre-backup)
Expand Down
10 changes: 6 additions & 4 deletions src/pages/reference/plans.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Starter plans get $5 of credits that do not accumulate.

Starter plans also have an execution limit, users get 500 execution hours per month. Hours get consumed if you at least have one service live.

If you have one service, it will deplete the 500 hour reserve at a normal rate. If you have two services, the timer will also deplete at a normal rate.
If you have one service, it will deplete the 500-hour reserve at a normal rate. If you have two services, the timer will also deplete at a normal rate.

Once you have run out of hours for that month, your deployment will be suspended until the next month, were you have to manually restart it.

**Tier Offering**

Expand Down Expand Up @@ -41,7 +43,7 @@ If a user unsubscribes or runs out of prepaid credits, the user returns to the S
- Max 100 GB of Disk (Soft cap)
- Max 5 members per project

The Developer Plan is meant for serious hobbyist use-cases. We do urge companies to upgrade to the Teams plan for for a commercial license to use Railway.
The Developer Plan is meant for serious hobbyist use-cases. We do urge companies to upgrade to the Teams plan for a commercial license to use Railway.

### Upgrading to the Developer Plan

Expand Down Expand Up @@ -71,7 +73,7 @@ Credits cannot be bought with:

## Team Plan Offering

Team plan projects are designed to provide the most resources for all your scaled needs. Team project usage is charged in addition to the number of seats the team pays for.
Team plan projects are designed to provide the most resources for all your scaled needs. The team plan has project usage charged in addition to the number of seats that the team pays for.

Unlike the starter and developer projects, team members within a team can access all team projects.

Expand All @@ -95,7 +97,7 @@ Execution hours are how we measure how long an account has at least one deploy.

However, they are not a direct measurement of the time your app has been up. It is a separate measure of your app's compute usage.

Railway limits free accounts to 500 hours of continuous uptime. If you have a deploy live, time is consumed.
Railway limits free accounts to 500 hours of continuous uptime. If you have a deployment live, time is consumed.

### Example Calculation

Expand Down
6 changes: 3 additions & 3 deletions src/pages/reference/pricing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@
title: Pricing
---

Railway offers a consumption-based pricing model for your projects. You don't get charged for resources you don't useRailway charges by the minute for each vCPU and memory resource your service uses.
Railway offers a consumption-based pricing model for your projects. You don't get charged for resources you don't use, instead, Railway charges by the minute for each vCPU and memory resource your service uses.

Users who upgrade to the Developer plan get unlimited execution time on their workloads and increased service limits compared to users on the Starter plan.
Users who upgrade to the Developer plan get unlimited execution hours on their workloads and increased service limits compared to users on the Starter plan.

[You can see the offerings of each tier on this page.](/reference/plans)

## Pricing Rates

Railway computes the usage cost with the following formula:

`Num Services` x (`Service Time` (in minutes) x (`Memory usage` (in GB) + `vCPU usage` (in cores))
`Num Services` x (`Service Time` (in minutes) x (`Memory usage` (in GB)) + `vCPU usage` (in cores))

And our rates for usage are as follows:

Expand Down
6 changes: 3 additions & 3 deletions src/pages/reference/priority-boarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Priority Boarding
---

Priority Boarding is Railway's beta program. The Railway Team frequently makes new features available to Priority Boarding members and provides a Discord channel to collect feedback before general availability.
Priority Boarding is Railway's beta program. The railway team are always working on pushing new beta features out to priority boarding. We also offer a Discord channel dedicated to this, allowing you to submit feedback.

To read more about Priority Boarding, check out [Priority Boarding: The Journey to Get There](https://blog.railway.app/p/building-the-beta).

Expand All @@ -19,7 +19,7 @@ Once connected to Discord, you'll need to let Percy, the Railway Discord bot, kn

In Discord, open up any channel, enter `/beta`, and follow the prompts.

You should now have access to the `#priority-boarding` channel and you should also see that your Account Settings now display a new Priority Boarding status.
You should now have access to the `#priority-boarding` channel. You should also see that your Account Settings now display a new Priority Boarding status.

<Image src="https://res.cloudinary.com/railway/image/upload/v1666372408/docs/priority-boarding-settings_wvvza4.png"
alt="Screenshot of Account Settings - Priority Boarding"
Expand All @@ -28,4 +28,4 @@ width={1004} height={468} quality={80} />

From this point forward, you'll have Priority Boarding features automatically enabled for your account. We'll notify you of any new features via the [Changelog](https://railway.app/changelog). We kindly request that you report any issues you encounter in the Discord channel.

That's all there is to it! Thanks for helping improve Railway and we'll see you in Priority Boarding.
That's all there is to it! Thanks for helping improve Railway, and we'll see you in Priority Boarding.
2 changes: 1 addition & 1 deletion src/pages/reference/public-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ mutation pluginCreate {

## Rate Limits

In order to protect the Railway API from abuse, we have established some basic rate limits. The current limit is **1000** requests per **day** to the API. To help you keep track of your usage, Railway sends a few headers with the response on each request.
In order to protect the Railway API from spam and misusage, we have established some basic rate limits. The current limit is **1000** requests per **day** to the API. To help you keep track of your usage, Railway sends a few headers with the response on each request.

| Header | Description |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down
Loading

0 comments on commit e5763f0

Please sign in to comment.