Skip to content

Commit 738fde4

Browse files
authored
Merge pull request rails#52251 from rails/fxn/edits
Edits in the dev containers guide
2 parents 35a4946 + 47a5d06 commit 738fde4

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

guides/source/getting_started_with_devcontainer.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@
33
Getting Started with Dev Containers
44
===================================
55

6-
After reading this guide, you know:
6+
After reading this guide, you will know:
77

8-
* How to create a new Rails application with the `rails-new` tool
9-
* How to begin working with your application in a Dev Container
8+
* How to create a new Rails application with the `rails-new` tool.
9+
* How to begin working with your application in a development container.
1010

1111
--------------------------------------------------------------------------------
1212

1313
The best way to read this guide is to follow it step by step. All steps are
1414
essential to run this example application and no additional code or steps are
1515
needed.
1616

17-
This guide helps you get set up with [Developer Containers (or Dev Containers for short)](https://containers.dev/)
18-
for a full-featured development environment. Dev Containers are used to run your
19-
Rails application in a container, without needing to install Rails or its dependencies
17+
This guide helps you get set up with [development containers (or dev containers for short)](https://containers.dev/)
18+
for a full-featured development environment. Dev containers are used to run your
19+
Rails application in a container, without needing to install Ruby or Rails or its dependencies
2020
directly on your machine. This is the fastest way to get your Rails application up and running.
2121

2222
This is an alternative to installing Ruby and Rails directly on your machine, which is
@@ -27,38 +27,38 @@ the Getting Started guide.
2727
Setup and Installation
2828
----------------------
2929

30-
To get set up, you will need to install the relevant tools; Docker, VSCode and
31-
`rails-new`. We'll go into detail about each one below.
30+
To get set up, you will need to install the relevant tools; Docker, VS Code and
31+
`rails-new`. We'll go into details about each one below.
3232

3333
### Installing Docker
3434

35-
Dev Containers are run using Docker, an open platform for developing, shipping, and
35+
Dev containers are run using Docker, an open platform for developing, shipping, and
3636
running applications. You can install Docker by following the installation instructions
3737
for your operating system in the [Docker docs](https://docs.docker.com/desktop/).
3838

39-
Once Docker has been installed, launch the Docker Application to begin running
39+
Once Docker has been installed, launch the Docker application to begin running
4040
the Docker engine on your machine.
4141

42-
### Installing VSCode
42+
### Installing VS Code
4343

44-
Visual Studio Code (VSCode) is an open source code editor developed by Microsoft. VSCode's Dev Container
44+
Visual Studio Code (VS Code) is an open source code editor developed by Microsoft. VS Code's Dev Containers
4545
extension allows you to open any folder inside (or mounted into) a container and take advantage of
4646
Visual Studio Code's full feature set. A [devcontainer.json](https://code.visualstudio.com/docs/devcontainers/containers#_create-a-devcontainerjson-file)
4747
file in your project tells VS Code how to access (or create) a development container with a
4848
well-defined tool and runtime stack. It allows you to quickly spin up containers, access terminal
4949
commands, debug code, and utilize extensions.
5050

51-
You can install VSCode by downloading it from [the website](https://code.visualstudio.com/).
51+
You can install VS Code by downloading it from [the website](https://code.visualstudio.com/).
5252

53-
You can install the Dev Container extension by downloading it from [the marketplace](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
53+
You can install the Dev Containers extension by downloading it from [the marketplace](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
5454

5555
### Installing rails-new
5656

5757
`rails-new` generates a new Rails application for you without having to install Ruby on
5858
your machine. It uses Docker to generate the Rails application, thus allowing Docker to
5959
take care of installing the correct Ruby and Rails versions for you.
6060

61-
To install rails-new, follow the installation instructions [in the readme](https://github.com/rails/rails-new?tab=readme-ov-file#installation).
61+
To install `rails-new`, follow the installation instructions [in the README](https://github.com/rails/rails-new?tab=readme-ov-file#installation).
6262

6363
Creating the Blog Application
6464
-----------------------------
@@ -99,25 +99,25 @@ see the full [Getting Started guide](getting_started.html#creating-the-blog-appl
9999
Opening the Blog Application in a Dev Container
100100
-----------------------------------------------
101101

102-
Our new Rails application comes with a Dev Container already configured and ready to use.
103-
We will use VSCode to spin up and work with our Dev Container. Start by launching VSCode
102+
Our new Rails application comes with a dev container already configured and ready to use.
103+
We will use VS Code to spin up and work with our dev container. Start by launching VS Code
104104
and opening your application.
105105

106-
Once the application opens, VSCode should prompt you that a it has found a Dev Container
107-
configuration file, and you can reopen the folder in a Dev Container. Click the green "Reopen
108-
in Container" button to create the Dev Container.
106+
Once the application opens, VS Code should prompt you that a it has found a dev container
107+
configuration file, and you can reopen the folder in a dev container. Click the green "Reopen
108+
in Container" button to create the dev container.
109109

110-
Once the Dev Container setup is complete, your development environment is ready to use,
110+
Once the dev container setup is complete, your development environment is ready to use,
111111
with Ruby, Rails, and all your dependencies installed.
112112

113-
You can open the terminal within VScode to verify that Rails is installed:
113+
You can open the terminal within VS Code to verify that Rails is installed:
114114

115115
```bash
116116
$ rails --version
117117
Rails 8.0.0
118118
```
119119

120120
You can now continue with the [Getting Started guide](getting_started.html#hello-rails) and
121-
begin building your Blog application. You will be working within VSCode, which serves as
122-
your entry point to your application's Dev Container, where you can run code, run tests and
121+
begin building your Blog application. You will be working within VS Code, which serves as
122+
your entry point to your application's dev container, where you can run code, run tests, and
123123
run your application.

0 commit comments

Comments
 (0)