Skip to content

Commit d6ceeb9

Browse files
Small grammar fixes and rewording (#132)
* Small grammar fixes and rewording Reword some sentences to read more naturally and also adjust the grammar a bit here and there.
1 parent b9bd143 commit d6ceeb9

File tree

5 files changed

+24
-23
lines changed

5 files changed

+24
-23
lines changed

content/config/create_as.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ nav_order: 10
1010

1111
In order to create a SCIONLab AS you must login on [SCIONLab](https://www.scionlab.org). In case you don't have an account yet, please follow the registration process.
1212

13-
After loggin in, you land on the `My ASes` page.
13+
After logging in, you will land on the `My ASes` page.
1414

1515
![Empty SCIONLab MyASes page](../images/scionlab_user_page_empty.png)
1616

1717
* The `My ASes` link in the navbar brings you back to this page when you navigate away.
18-
* The drop-down menu under the <span class="fa fa-user"></span>-symbol in the navbar contains links to change your password and log-out.
18+
* The drop-down menu under the <span class="fa fa-user"></span>-symbol in the navbar contains links to change your password and to log out.
1919

2020
This view is initially empty, later you will see a list of your ASes:
2121

@@ -24,12 +24,12 @@ This view is initially empty, later you will see a list of your ASes:
2424
* The columns in this summary refer to the configuration you've made for this AS, as discussed below.
2525
* The link with the <span class="fa fa-pencil"></span>-symbol in the `AS ID` column brings you to the edit page for an AS.
2626
* The link with the <span class="fa fa-download"></span>-symbol in the `Configuration` column lets you download the configuration tarfile for an AS.
27-
* The tick or cross in the `Active` column indicate whether an AS has been deactivated (using the corresponding button in the edit page).
27+
* The tick or cross in the `Active` column indicates whether an AS has been deactivated (using the corresponding button on the edit page).
2828

2929

3030
## Configure a SCIONLab AS
3131

32-
The `Create a new SCIONLab AS` button or on the edit link for an existing AS will bring you to the same configuration form.
32+
The `Create a new SCIONLab AS` button or the edit link for an existing AS will bring you to the same configuration form.
3333

3434
![Configure ASes form](../images/scionlab_user_as_form.png)
3535

@@ -57,7 +57,7 @@ The following options are the parameters for the overlay link between the border
5757
* you are **behind a NAT or firewall** and you cannot open/forward a chosen UDP port
5858
* you want to _"just make it work"_, as you'll need to know no further details about your network configuration
5959

60-
The configuration file will contain an OpenVPN configuration file `client.conf`.
60+
The configuration file will contain an OpenVPN configuration file named `client.conf`.
6161
After extracting this file to `/etc/openvpn/`, you can start the tunnel by running `sudo systemctl start openvpn@client`.
6262

6363
* Public IP Address, Bind IP Address
@@ -73,11 +73,10 @@ The following options are the parameters for the overlay link between the border
7373

7474

7575

76-
If your host has a public IP (the public IP is identical with the local IP), only fill the `Public IP Address` field and
77-
leave the `Bind IP Address` field blank.
76+
If your host has a public IP (the public IP is identical with the local IP), only fill in the `Public IP Address` field and leave the `Bind IP Address` field blank.
7877

7978

80-
If you are in a network behind a NAT (the public IP and local IP are different), fill the `Public IP Address` field with the public IP and the `Bind IP Address` field with the local IP address.
79+
If you are in a network behind a NAT (i.e. the public IP and local IP are different), fill the `Public IP Address` field with the public IP and the `Bind IP Address` field with the local IP address.
8180

8281

8382
{% include alert type="note" content="

content/faq/join_infrastructure.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ There are a few requirements for you or your organization to join SCIONLab as an
2929

3030
- Infrastructure ASes and nodes are required to be active 24 hours a day, 7 days a week. The SCIONLab administrators can typically handle all SCION related problems, but sometimes they will contact you if they cannot perform certain tasks. An example would be to change a drive if it failed, etc.
3131
- The machine should have a minimum of 4 CPUs, 8 GB of RAM and 40 GB of disk space. In most of the cases a VM can suffice.
32-
- OS for the SCION infrastructure node must be Ubuntu 18.04.
32+
- The OS for the SCION infrastructure node must be Ubuntu 18.04.
3333
- The border router node(s) must have a public static IP address. Any other SCION services can run with private static IP addresses.
3434
- Any firewalls affecting the node must be configured according to the [SCION AS connectivity matrix](./as_connectivity.html).
3535

@@ -39,4 +39,4 @@ The following are not requirements, but recommendations:
3939

4040
- The border router should be near (latency-wise) the IP border of your AS or organization.
4141
- Co-locating the nodes in your datacenter is usually a good idea as it reduces network latency.
42-
- Given the fact SCIONLab is a research network dedicated mainly for running experiments, you may want to place the SCIONLab node(s) in a DMZ or a dedicated subnet.
42+
- Given the fact that SCIONLab is a research network dedicated mainly to running experiments, you may want to place the SCIONLab node(s) in a DMZ or a dedicated subnet.

content/faq/troubleshooting.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ The following relate to AS [configured to use VPN](../config/create_as.html#conf
5959

6060
Check the OpenVPN client log for specific information, using `sudo journalctl -e -u openvpn`.
6161

62-
An unspecific timeout typically indicates that your behind a firewall that blocks UDP port 1194. Please contact your network administrators to unblock this port.
62+
An unspecific timeout typically indicates that you are behind a firewall that blocks UDP port 1194. Please contact your network administrators to unblock this port.
6363

6464

6565
#### Border Router fails to start
6666

67-
If you see (e.g. that your border router did not start, it is likely that the border router was trying to start before the VPN tunnel interface was up.
67+
If you see for example that your border router did not start, it is likely that the border router was trying to start before the VPN tunnel interface was up.
6868

6969
Simply try again;
7070

@@ -86,7 +86,7 @@ The following are common issues or troubleshooting strategies for a SCION AS.
8686

8787
Typically, this indicates a configuration error.
8888

89-
If you've configured to use VPN, check the "Border Router fails to start" entry in the VPN section above.
89+
If you've configured to use a VPN, check the "Border Router fails to start" entry in the VPN section above.
9090

9191
Inspect the logs of the failed services to find details.
9292
In case of multiple failures, fixing issues in the following order usually works best:
@@ -105,7 +105,7 @@ First clear the `/var/log/scion/` directory and restart. This often helps to fin
105105

106106
Log of the beacon server (`/var/logs/scion/bs*.log`) does not contain recent entries referring to `Registered beacons`.
107107

108-
As at the time of writing there are certain failure modes of the border routers that are hard to diagnose and are fixed with a simple restart, first thing to try is to turn it off and on again:
108+
As at the time of writing there are certain failure modes of the border routers that are hard to diagnose and are fixed with a simple restart, the first thing to try is to turn it off and on again:
109109

110110
```
111111
sudo systemctl restart scionlab.target

content/install/src.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ nav_order: 30
66

77
# Building from sources (Linux)
88

9-
If you're planning to make modifications to SCION implementation, you can build SCION from sources and run your SCIONLab AS with your own version of SCION.
10-
For developer's convenience, SCIONLab supports generating configurations that are compatible with the scripts and machinery intended to run SCION in a development environment.
9+
If you are planning to make modifications to the SCION implementation, you can build SCION from sources and run your SCIONLab AS with your own version of SCION.
10+
For developers' convenience, SCIONLab supports generating configurations that are compatible with the scripts and machinery intended to run SCION in a development environment.
1111

1212
Building SCION from sources requires following a lengthy setup procedure and installing various development dependencies.
1313
The development setup is currently supported/documented for **Ubuntu 16.04 _only_**.
@@ -33,7 +33,7 @@ on top of SCION.
3333
After having managed to build SCION and after [creating or modifying your AS](../config/create_as.html) in the SCIONLab coordination website, you can deploy the generated configuration to your machine.
3434

3535
1. Download the configuration tarfile from the SCIONLab coordination website.
36-
2. If using VPN, unpack the `client.conf` to `/etc/openvpn/` and start OpenVPN
36+
2. If you plan on using a VPN, unpack the `client.conf` to `/etc/openvpn/` and start OpenVPN
3737
```shell
3838
sudo systemctl restart openvpn@client
3939
```

content/install/vm.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ nav_order: 10
66

77
# Running inside a VM
88

9-
## Install Vagrant and Virtualbox
9+
## Installing Vagrant and VirtualBox
10+
1011
If you choose to run a SCIONLab virtual machine, you need to install [Vagrant](https://www.vagrantup.com/) and
1112
[VirtualBox](https://www.virtualbox.org/). These are available for most platforms, including Linux, Windows and macOS.
1213

@@ -24,7 +25,7 @@ For other platforms, please consult the official installation instructions:
2425
## Using Vagrant to run the VM
2526

2627
After [creating your AS](../config/create_as.html) in the SCIONLab coordination
27-
website, you will be able to download a tarfile with `Vagrantfile` allowing you to easily build your SCIONLab VM.
28+
website, you will be able to download a tarfile containing a `Vagrantfile` which allows you to easily build your SCIONLab VM.
2829

2930
{% include alert type="note" content="
3031
All the commands below need to be executed from the directory containing the Vagrantfile.
@@ -36,8 +37,9 @@ To start your VM, run
3637
vagrant up
3738
```
3839

39-
When running your VM for the first time, base Ubuntu OS will be installed together with SCIONLab packages and their
40-
dependencies. After the installation SCIONLab services should be already up and running.
40+
When running your VM for the first time, the base Ubuntu OS will be installed together with the
41+
SCIONLab packages and their dependencies. After the installation, SCIONLab services should already
42+
be up and running.
4143

4244
Once the `vagrant up` command returns the prompt, you can connect to your VM to
4345
start exploring:
@@ -46,10 +48,10 @@ start exploring:
4648
vagrant ssh
4749
```
4850

49-
The directory containing the Vagrant file is synced with the VM where the files
51+
The directory containing the Vagrant file is synced with the VM, in which the files
5052
will appear in the `/vagrant/` directory.
5153
This is a convenient way to share files between your host machine and your
52-
VM, and allows to move data both ways.
54+
VM, and enables moving data both ways.
5355

5456
{% include alert type="note" content="
5557
You can use following Vagrant commands to perform various operations with your VM

0 commit comments

Comments
 (0)