Skip to content

Commit 95fd751

Browse files
authored
Improve language in multipass/Linux.md (#91)
* Improve language in multipass/Linux.md Did things like: made sentences more concise, aligned writing with canonical documentation guideline by ensuring that words and phrases that should be avoided are avoided - pronouns are used right and consistently - and words are British instead of American, corrected grammatical errros by using words properly (like the word <now>, recommending when it is used as an adverb and when it is not), and re-wrote confusing sentences. * Made changes to Linux.md incorporated suggested changes and ensured that new corrections/ideas are consistely implemented * Improved Windows.md and macOS.md, and fixed new things in Linux.md Made improvements to Windows.md and macOS.md generally. Then made specific improvements spotted while re-writing those two to Linux.md. * implement suggested changes * implement suggested changes not included in the previous commit
1 parent dc6fffc commit 95fd751

File tree

3 files changed

+114
-100
lines changed

3 files changed

+114
-100
lines changed

multipass/Linux.md

Lines changed: 39 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
nhart | 2023-12-07 11:18:47 UTC | #1
22

3-
Multipass is a flexible, powerful tool that can be used for many purposes. In its simplest form, it can be used to quickly create and destroy Ubuntu VMs (instances) on any host machine. Used to a fuller extent, Multipass is a local mini-cloud on your laptop, allowing the testing and development of multi-instance or container-based cloud applications.
3+
Multipass is a flexible and powerful tool that can be used for many purposes. In its simplest form, it can be used to quickly create and destroy Ubuntu VMs (instances) on any host machine. When used maximally, Multipass is a local mini-cloud on your laptop, ensuring that you can test and develop multi-instance or container-based cloud applications.
44

5-
This tutorial will give you an understanding of how Multipass works, and the skills you need to use its main features.
5+
This tutorial will help you understand how Multipass works, and the skills you need to use its main features.
66

77

88
## Contents
@@ -18,8 +18,9 @@ This tutorial will give you an understanding of how Multipass works, and the ski
1818

1919
<a href="#heading--install-multipass"><h2 id="heading--install-multipass">Install Multipass</h3></a>
2020

21-
Multipass is available for Linux, macOs, or Windows. To install it on your OS of choice, please follow the instructions given [here](https://multipass.run/docs/how-to-guides). Note: This tutorial demonstrates use on Linux, specifically Ubuntu, but the experience on any OS should be similar.
21+
Multipass is available for Linux, macOS and Windows. To install it on the OS of your choice, please follow the instructions given in this [how-to-guides](https://multipass.run/docs/how-to-guides).
2222

23+
Note that this tutorial demonstrates how to use Multipass on Linux, specifically Ubuntu, but the experience on any OS should be similar.
2324

2425
<a href="#heading--create-and-use-a-basic-instance"><h2 id="heading--create-and-use-a-basic-instance">Create and use a basic instance</h2></a>
2526

@@ -30,20 +31,21 @@ The primary instance is a Multipass virtual machine that is configured to be use
3031
3132
The primary instance automatically mounts the $HOME directory (files in this directory are shared between the host and the instance), and it comes with Multipass's default specs: 1GB of RAM, 5GB of disk, and 1 CPU.
3233
-->
33-
34-
From the application launcher, let's start Multipass. In Ubuntu, press the super key and type Multipass, or find Multipass in the Applications panel in the lower left of the desktop.
34+
Start Multipass from the application launcher. In Ubuntu, press the super key and type "Multipass", or find Multipass in the Applications panel on the lower left of the desktop.
3535

3636
![|800x450](https://assets.ubuntu.com/v1/949aa05e-mp-linux-1.png)
3737

38-
Once we've launched the application, we should see the Multipass tray icon in the upper right section of the screen:
38+
After launching the application, you should see the Multipass tray icon on the upper right section of the screen.
3939

4040
![|688x52](https://assets.ubuntu.com/v1/5ec546da-mp-linux-2.png)
4141

42-
Let's click on the icon, then on "Open Shell".
42+
Click on the Multipass icon and select **Open Shell**.
4343

4444
![|286x274](https://assets.ubuntu.com/v1/3ecc5e7d-mp-linux-2a.png)
4545

46-
Clicking this button does many things in the background: it creates a new virtual machine (instance), named `primary`, with 1GB of RAM, 5GB of disk, and 1 CPU; installs the most recent Ubuntu LTS release on that instance; mounts our $HOME directory in the instance; and opens a shell to the instance, announced by the command prompt `ubuntu@primary`. You can see elements of this in the printout below.
46+
Clicking this button does many things in the background. First, it creates a new virtual machine (instance) named "primary", with 1GB of RAM, 5GB of disk, and 1 CPU. Second, it installs the most recent Ubuntu LTS release on that instance. Third, it mounts your `$HOME` directory in the instance. Last, it opens a shell to the instance, announced by the command prompt `ubuntu@primary`.
47+
48+
You can see elements of this in the printout below:
4749

4850
```plain
4951
Launched: primary
@@ -75,11 +77,11 @@ To check for new updates run: sudo apt update
7577
ubuntu@primary:~$
7678
```
7779

78-
Let's test it out! As we just learned, the previous step automatically mounted our $HOME directory in the instance. Let's use this to share data with our instance. More concretely, let's create a new folder in our $HOME directory called Multipass_Files:
80+
Let's test it out. As you've just learnt, the previous step automatically mounted your `$HOME` directory in the instance. Use this to share data with your instance. More concretely, create a new folder called `Multipass_Files` in your `$HOME` directory.
7981

8082
![|720x405](https://assets.ubuntu.com/v1/fbfc8304-mp-linux-3.png)
8183

82-
As you can see, I've added a readme file in this shared folder. Let's check for the folder and read the file from our new instance:
84+
As you can see, a `README.md` file has been added to the shared folder. Check for the folder and read the file from your new instance:
8385

8486
```plain
8587
ubuntu@primary:~$ cd ./Home/Multipass_Files/
@@ -93,19 +95,19 @@ ubuntu@primary:~/Home/Multipass_Files$
9395

9496
Congratulations, you've got your first instance!
9597

96-
This instance is great for when we just need a quick Ubuntu VM, but let's say we want a more customised instance. Multipass has us covered there too!
98+
This instance is great for when you just need a quick Ubuntu VM, but let's say you want a more customised instance, how can you do that? Multipass has you covered there too.
9799

98100
[details = "Optional Exercises"]
99101
Exercise 1:
100-
When you clicked on Open Shell just now, what happened in the background was the equivalent of the CLI commands `multipass launch –name primary` followed by `multipass shell`. Open a terminal and try `multipass shell` (if you didn't follow the steps above, you will have to run the `launch` command first).
102+
When you select Open Shell, what happens in the background is the equivalent of the CLI commands `multipass launch –name primary` followed by `multipass shell`. Open a terminal and try `multipass shell` (if you didn't follow the steps above, you will have to run the `launch` command first).
101103

102104
Exercise 2:
103-
In Multipass, an instance with the name `primary` is privileged. For example, it is the default argument of multipass shell. In two terminal instances, check `multipass shell primary` and `multipass shell`. Both commands should give the same result.
105+
In Multipass, an instance with the name "primary" is privileged. That is, it serves as the default argument of `multipass shell` among other capabilities. In different terminal instances, check `multipass shell primary` and `multipass shell`. Both commands should give the same result.
104106
[/details]
105107

106108
<a href="#heading--create-a-customised-instance"><h2 id="heading--create-a-customised-instance">Create a customised instance</h3></a>
107109

108-
Multipass has a great feature to help us get started creating customised instances. Let's open a terminal and run the command `multipass find`. This shows us a list of all of the images we can launch through Multipass currently.
110+
Multipass has a great feature to help you get started with creating customised instances. Open a terminal and run the `multipass find` command. The result shows a list of all images you can currently launch through Multipass.
109111

110112
```plain
111113
$ multipass find
@@ -135,16 +137,16 @@ jellyfin latest Jellyfin is a Fre
135137
minikube latest minikube is local Kubernetes
136138
```
137139

138-
Let's launch an instance running Ubuntu 22.10 ("Kinetic Kudu") by typing the command `multipass launch kinetic`
140+
Launch an instance running Ubuntu 22.10 ("Kinetic Kudu") by typing the `multipass launch kinetic` command.
139141

140-
Now we have an instance running which has been named randomly by Multipass, in my case it is called "coherent-trumpetfish".
142+
Now, you have an instance running and it has been named randomly by Multipass. In this case, it has been named "coherent-trumpetfish".
141143

142144
```plain
143145
$ multipass launch kinetic
144146
Launched: coherent-trumpetfish
145147
```
146148

147-
We can check some basic info about our new instance by running the following:
149+
You can check some basic info about your new instance by running the following command:
148150

149151
`multipass exec coherent-trumpetfish -- lsb_release -a`
150152

@@ -159,17 +161,17 @@ Release: 22.10
159161
Codename: kinetic
160162
```
161163

162-
Perhaps after using this instance for a while, we decide what we really need is the latest LTS version of Ubuntu, with a more informative name and a little more memory and disk. We can delete the "coherent-trumpetfish" instance by running
164+
Perhaps after using this instance for a while, you decide that what you really need is the latest LTS version of Ubuntu, with a more informative name and a little more memory and disk. You can delete the "coherent-trumpetfish" instance by running the following command:
163165

164166
`multipass delete coherent-trumpetfish`
165167

166-
Let's now launch the type of instance we're looking for by running this:
168+
You can now launch the type of instance you need by running this command:
167169

168170
`multipass launch lts --name ltsInstance --memory 2G --disk 10G --cpus 2`
169171

170172
<a href="#heading--manage-instances"><h2 id="heading--manage-instances">Manage instances</h3></a>
171173

172-
Now let's confirm this new instance has the specs we're looking for by running `multipass info ltsInstance`
174+
You can confirm that the new instance has the specs you need by running `multipass info ltsInstance`.
173175

174176
```plain
175177
$ multipass info ltsInstance
@@ -185,7 +187,7 @@ Memory usage: 170.4MiB out of 1.9GiB
185187
Mounts: --
186188
```
187189

188-
We've created and deleted quite a few instances now. Let's run multipass list to see what instances we currently have.
190+
You've created and deleted quite a few instances. It is time to run `multipass list` to see the instances you currently have.
189191

190192
```plain
191193
$ multipass list
@@ -195,7 +197,7 @@ coherent-trumpetfish Deleted -- Not Available
195197
ltsInstance Running 10.110.66.139 Ubuntu 22.04 LTS
196198
```
197199

198-
We have two instances currently running, the primary instance and our LTS machine with customised specs. Our "coherent-trumpetfish" instance is still listed, but its state is "Deleted". We can recover this instance by running `multipass recover coherent-trumpetfish`, but for right now let's delete the instance permanently by running `multipass purge`. Running `multipass list` again confirms the instance is now permanently deleted:
200+
The result shows that you have two instances running, the "primary" instance and the LTS machine with customised specs. The "coherent-trumpetfish" instance is still listed, but its state is "Deleted". You can recover this instance by running `multipass recover coherent-trumpetfish`. But for now, delete the instance permanently by running `multipass purge`. Then run `multipass list` again to confirm that the instance has been permanently deleted.
199201

200202
```plain
201203
$ multipass list
@@ -204,35 +206,37 @@ primary Running 10.110.66.242 Ubuntu 22.04 LTS
204206
ltsInstance Running 10.110.66.139 Ubuntu 22.04 LTS
205207
```
206208

207-
We've now seen a few ways to create, customise, and delete an instance. Now let's put those instances to work!
209+
You've now seen a few ways to create, customise, and delete an instance. It is time to put those instances to work!
208210

209211
<a href="#heading--put-your-instances-to-use"><h2 id="heading--put-your-instances-to-use">Put your instances to use</h2></a>
210212

213+
One way to put a Multipass instance to use is by running a local or web server in it.
214+
211215
<a href="#heading--run-a-simple-web-server"><h3 id="heading--run-a-simple-web-server">Run a simple web server</h3></a>
212216

213-
Let's go back to that customised LTS instance we created. Take note of its IP address revealed by `multipass list` in the previous step, then run `multipass shell ltsInstance` to open a shell in the instance.
217+
Return to your customised LTS instance. Take note of its IP address, which was revealed when you ran `multipass list`. Then run `multipass shell ltsInstance` to open a shell in the instance.
214218

215-
From the shell, we can now run:
219+
From the shell, you can run:
216220

217221
```
218222
sudo apt update
219223
220224
sudo apt install apache2
221225
```
222226

223-
Now, let's open a browser and type in the IP address of the instance into the address bar. We should now see the default Apache homepage.
227+
Open a browser and type in the IP address of your instance into the address bar. You should now see the default Apache homepage.
224228

225229
![|720x545](https://assets.ubuntu.com/v1/e106f7f9-mp-linux-4.png)
226230

227-
Just like that, we've got a web server running in a Multipass instance!
231+
Just like that, you've got a web server running in a Multipass instance!
228232

229-
We can use this web server locally for any kind of local development or testing we like. If however, we want to access this web server from the internet (e.g. from a different computer), we need an instance that is exposed to the external network.
233+
You can use this web server locally for any kind of local development or testing. However, if you want to access this web server from the internet (for instance, a different computer), you need an instance that is exposed to the external network.
230234

231235
<a href="#heading--launch-from-a-blueprint-to-run-docker-containers"><h3 id="heading--launch-from-a-blueprint-to-run-docker-containers">Launch from a Blueprint to run Docker containers</h3></a>
232236

233-
Some environments require a lot of configuration and setup. Multipass Blueprints are instances with a deep level of customization. The Docker Blueprint, for example, is a pre-configured Docker environment with a Portainer container already running. We can launch an instance using the Docker Blueprint by running `multipass launch docker --name docker-dev`
237+
Some environments require a lot of configuration and setup. Multipass Blueprints are instances with a deep level of customization. For example, the Docker Blueprint is a pre-configured Docker environment with a Portainer container already running. You can launch an instance using the Docker Blueprint by running `multipass launch docker --name docker-dev`.
234238

235-
Once that's finished, let's run `multipass info docker-dev` to note down the IP of the new instance.
239+
Once that's done, run `multipass info docker-dev` to note down the IP of the new instance.
236240

237241
```plain
238242
$ multipass launch docker --name docker-dev
@@ -251,25 +255,25 @@ Memory usage: 259.7MiB out of 3.8GiB
251255
Mounts: --
252256
```
253257

254-
Let's take the IP address starting with "10" and paste it into our browser, then add a colon and the portainer default port, 9000, like this: 10.115.5.235:9000. This will take us to the Portainer login page, where we can set a username and password.
258+
Copy the IP address starting with "10" and paste it into your browser, then add a colon and the portainer default port, 9000. It should look like this: 10.115.5.235:9000. This will take you to the Portainer login page where you can set a username and password.
255259

256260
![|720x543](https://assets.ubuntu.com/v1/75a164a1-mp-linux-5.png)
257261

258-
From there, let's select a local docker environment.
262+
From there, select **Local** to manage a local Docker environment.
259263

260264
![|720x601](https://assets.ubuntu.com/v1/ee3ff308-mp-linux-6.png)
261265

262-
From there, we can click into the newly created "local" docker endpoint, navigate to the app templates page, and select NGINX
266+
Inside the newly selected local Docker environment, locate the sidebar menu on the page and click on **app templates**, then select **NGINX**.
263267

264268
![|720x460](https://assets.ubuntu.com/v1/86be3eae-mp-linux-7.png)
265269

266-
From the Portainer dashboard, we can see the ports that nginx has available. We can navigate to the IP address of our instance followed by that port number to see that we indeed have nginx running in a docker container inside Multipass!
270+
From the Portainer dashboard, you can see the ports available on nginx. To verify that you have nginx running in a Docker container inside Multipass, open a new web page and paste the IP address of your instance followed by one of the port numbers.
267271

268272
![|720x465](https://assets.ubuntu.com/v1/25585a03-mp-linux-8.png)
269273

270274
<a href="#heading--next-steps"><h2 id="heading--next-steps">Next steps</h2></a>
271275

272-
Congratulations! You now have the skills you need to use Multipass proficiently. There's more to learn about Multipass and its capabilities - check out our [how-to guides](https://multipass.run/docs/how-to-guides) for ideas and for help with your project. Our [reference page](https://multipass.run/docs/reference) contains definitions of key concepts, a complete CLI command reference, settings options and more.
276+
Congratulations! You can now use Multipass proficiently. There's more to learn about Multipass and its capabilities. Check out our [how-to guides](https://multipass.run/docs/how-to-guides) for ideas and help with your project. Our [reference pages](https://multipass.run/docs/reference) contain definitions of key concepts, a complete CLI command reference, settings options and more.
273277

274278
Let us know what you're able to get done with Multipass!
275279

0 commit comments

Comments
 (0)