fix typos

brainhackorg · Apr 1, 2022 · f9a8737 · f9a8737
1 parent c9028d3
commit f9a8737
Show file tree

Hide file tree

Showing 12 changed files with 41 additions and 67 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,14 +1,14 @@
 # CONTRIBUTING
 
 - [CONTRIBUTING](#contributing)
-    - [Repo map](#repo-map)
-    - [Build locally](#build-locally)
-        - [Prerequisites](#prerequisites)
-            - [node.js](#nodejs)
-            - [Hugo](#hugo)
-        - [Clone repo and its submodules](#clone-repo-and-its-submodules)
-        - [Install javascripts dependencies](#install-javascripts-dependencies)
-        - [Serve the website locally](#serve-the-website-locally)
+  - [Repo map](#repo-map)
+  - [Build locally](#build-locally)
+    - [Prerequisites](#prerequisites)
+      - [node.js](#nodejs)
+      - [Hugo](#hugo)
+    - [Clone repo and its submodules](#clone-repo-and-its-submodules)
+    - [Install javascripts dependencies](#install-javascripts-dependencies)
+    - [Serve the website locally](#serve-the-website-locally)
 
 ## Repo map
 
@@ -48,8 +48,8 @@
 
 #### node.js
 
-A quick version (for Mac and Linux) that will also allow to manage different version of node
-is to install node via the "node version manager".
+A quick version (for Mac and Linux) that will also allow managing of different versions of the node
+is to install the node via the "node version manager".
 
 ```bash
 curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash

diff --git a/content/en/admins/_index.md b/content/en/admins/_index.md
@@ -17,7 +17,7 @@ This section describes how the Admin team manages users and projects on the Orac
 
 To ask questions or suggest new features,
 [join the discussion](https://github.com/brainhackorg/brainhack_cloud/discussions)
-on github. For issues with the _brainhack cloud_, please open a
+on Github. For issues with the _Brainhack Cloud_, please open a
 [new issue](https://github.com/brainhackorg/brainhack_cloud/issues).
 
 ## Funding

diff --git a/content/en/admins/admins.md b/content/en/admins/admins.md
@@ -8,12 +8,12 @@ description: >
 
 ## Overview
 
-To increase security of our cloud tenancy an admin cannot create or remove other admins. This is the instruction for the admin-administrator to create new admin accounts: 
+To increase the security of our cloud tenancy an admin cannot create or remove other admins. This is the instruction for the admin-administrator to create new admin accounts: 
 
 
-## Create new admin
+## Create a new admin
 
-Admins need to use a "federated account" to login to the cloud instead of "local accounts".
+Admins need to use a "federated account" to login into the cloud instead of "local accounts".
 
 
 Go to `Federation` in `Identity`

diff --git a/content/en/admins/datascience.md b/content/en/admins/datascience.md
@@ -3,15 +3,15 @@ title: "Datascience setup"
 linkTitle: "Datascience setup"
 weight: 100
 description: >-
-     How to setup the datascience environments (only needs to be done once).
+     How to set up the datascience environments (only needs to be done once).
 ---
 
 ## Step 1) Create VCN and Subnets
 Create a VCN and subnets using Virtual Cloud Networks > Start VCN Wizard > VCN with Internet Connectivity option.
 The Networking Quickstart option automatically creates the necessary private subnet with a NAT gateway.
 ![image](https://user-images.githubusercontent.com/4021595/159605361-d8f4bf9b-e7c7-445d-89ce-8daee43801f1.png)
 
-## Step 2) Create Dynamic Group
+## Step 2) Create a Dynamic Group
 Create a dynamic group with the following matching rule:
 ALL { resource.type = 'datasciencenotebooksession' }
 ![image](https://user-images.githubusercontent.com/4021595/159605506-d0579916-2cce-461b-9d54-f703a53b7ad1.png)
@@ -24,7 +24,7 @@ Create a policy in the root compartment with the following statements:
 ### 3.1 Service Policies
 allow service datascience to use virtual-network-family in tenancy
 
--> created in root comparment as "datascience"
+-> created in root compartment as "datascience"
 
 ### 3.2 Non-Administrator User Policies
 allow group `data-scientists` to use virtual-network-family in tenancy
@@ -36,4 +36,4 @@ where `data-scientists` represents the name of your user group -> setup as "proj
 allow dynamic-group `dynamic-group` to manage data-science-family in tenancy
 where `dynamic-group` represents the name of your dynamic group
 
--> created as 	datascience-dynamic-group-policy in root compartment
+-> created as 	datascience-dynamic-group-policy in the root compartment
diff --git a/content/en/admins/resources.md b/content/en/admins/resources.md
@@ -7,7 +7,7 @@ description: >
 ---
 
 
-By default, every tenancy has strict resource limits. These make sure that the right resources are available in the datacenters where they are requested. An overview of which resources are available where can be found here:
+By default, every tenancy has strict resource limits. These make sure that the right resources are available in the data centers where they are requested. An overview of which resources are available where can be found here:
 https://www.oracle.com/cloud/data-regions/#northamerica
 
 
diff --git a/content/en/admins/team.md b/content/en/admins/team.md
@@ -6,8 +6,8 @@ description: >
   This is the team behind the scenes
 ---
 
-We applied for funding this project with Oracle Cloud for Research and the
-project is funded with $230,000.00 AUD from 29th of January 2022 until 28th of
+We applied for funding for this project with Oracle Cloud for Research and the
+project is funded with $230,000.00 AUD from the 29th of January 2022 until 28th of
 January, 2024.
 
 Please reach out to us if you would like to join the team:

diff --git a/content/en/admins/users.md b/content/en/admins/users.md
@@ -12,12 +12,10 @@ Once a new project is requested via the
 [Issue Template](https://github.com/brainhackorg/brainhack_cloud/issues/new?assignees=&labels=resource_request&template=request-resource-access.yml)
 one of the admins has to provision the project on the cloud.
 
-Here is an example for such a request:
+Here is an example of such a request:
 
 ![image](https://user-images.githubusercontent.com/4021595/157339176-d222994f-7d25-484c-99bb-67b354ab1e5a.png)
 
-Once such a request comes in, assign it to yourself so that other people know that you are working on it! Then continue ...
-
 ## Creating a new user
 
 Login to Oracle Cloud:
@@ -44,27 +42,9 @@ Copy this password and send it to the user you just created.
 
 The new user has to follow this procedure: [User request](./../../docs/request).
 
+Add the User to the group `cloudshell-access`
 
-Here is an email template:
-```
-Subject: Temporary Password for Oracle Cloud
-Text: 
-Dear REPLACEWITHUSER,
-
-This is your temporary password to activate your Oracle Cloud account. You should have an email in your inbox/spam folder with an activation link.
-
-PASTEPASSWORDHERE
-
-Please follow the rest of the instructions here to activate your account: https://brainhack.org/brainhack_cloud/docs/request/#activate-your-account
-
-All the best
-REPLACEWITHYOURNAME
-```
-
-
-Add the User to the group `projects`
-
-![image](https://user-images.githubusercontent.com/4021595/159605185-d4a52d2b-ba76-42bd-bfe2-8a19c1bd7c0a.png)
+![image](https://user-images.githubusercontent.com/4021595/157342248-9a63cdf0-c630-42b9-9222-c45e54916a38.png)
 
 Repeat this procedure for every user in the project.
 
@@ -74,8 +54,8 @@ Go back to Identity and click `Create Group`
 
 ![image](https://user-images.githubusercontent.com/4021595/157341864-5582074f-fa90-48f2-a2a5-deebb1a241dc.png)
 
-Give the group a name that represents the project (no spaces!) - as Description
-put the link to the github issue.
+Give the group a name that represents the project (no spaces!) - as a Description
+put the link to the Github issue.
 
 ![image](https://user-images.githubusercontent.com/4021595/157342047-92280e16-9518-4d04-a3be-796073d16c01.png)
 
@@ -87,32 +67,26 @@ Then add the User(s) to the group.
 
 Go back to `Identity` and head to `Compartments` and click `Create Compartment`.
 Name it like the group just created and add the Github issue link as
-the description. Parent compartment is `projects` under `brainhack (root)`.
-
-![image](https://user-images.githubusercontent.com/4021595/157600826-7056e58c-f4a6-4d12-b66f-13b6007b7095.png)
+the description. Parent compartment is brainhack (root).
 
+![image](https://user-images.githubusercontent.com/4021595/157342561-71a6ba34-7dd8-4d81-a382-621d0c4e10fa.png)
 
 ## Create Policy for group and compartment
 
 Go back to `Identity` and click on `Policies`. Click `Create Policy`. Name the
 policy like the group and compartment just created. The description is the Github
-issue link. You can either use the policy builder (Compartment Management -> Let compartment admins manage the compartment) or switch to manual. The
+issue link. You can either use the policy builder or switch to manual. The
 resulting policy needs to be
-`Allow group REPLACEWITHGROUPNAME to manage all-resources in compartment REPALCEWITHCOMPARTMENTNAME`. Make sure that the compartment "projects" is selected because we want this policy on the projects level (not in root!).
+`Allow group REPLACEWITHGROUPNAME to manage all-resources in compartment REPALCEWITHCOMPARTMENTNAME`.
 
-![image](https://user-images.githubusercontent.com/4021595/157776607-e88b38db-cae2-4593-8785-50c34e39e479.png)
+![image](https://user-images.githubusercontent.com/4021595/157343055-f726641a-ae85-4eab-9cff-5b1f08a70db3.png)
 
-## Create Budget for compartment
+## Create a Budget for compartment
 
 Budgets help us to control and monitor costs. For every compartment, we need a
-budget with someone being alerted when things go wrong:
+budget with someone being alerted when things go crazy:
 
 Go to `Budgets` under `Cost Management` and click `Create Budget`. Add the
-project details (name and issue link as description), set the Budget to `1000` AUD, switch to `Forecast Spend` and set a threshold of `100`% and add your email to the alert list + a second admin as backup.
-
-![image](https://user-images.githubusercontent.com/4021595/157601668-ee7281f3-8f49-4db9-b20b-deca29e03c19.png)
-
-
-## Cleanup
+project details and add your email to the alert list.
 
-Go back to the Github issue and let the project know that everything is setup and close the issue.
+![image](https://user-images.githubusercontent.com/4021595/157346505-be192493-6937-4574-87a8-1ceb898bae81.png)
diff --git a/content/en/docs/_index.md b/content/en/docs/_index.md
@@ -17,7 +17,7 @@ This section contains documentation on how to use the Oracle Cloud.
 
 To ask questions or suggest new features,
 [join the discussion](https://github.com/brainhackorg/brainhack_cloud/discussions)
-on github. For issues with the _brainhack cloud_, please open a
+on Github. For issues with the _brainhack cloud_, please open a
 [new issue](https://github.com/brainhackorg/brainhack_cloud/issues).
 
 ## Acknowledgments

diff --git a/content/en/docs/docker.md b/content/en/docs/docker.md
@@ -24,7 +24,7 @@ sudo systemctl start docker.service
 ```
 
 ## OR: Installing Podman instead of Docker
-Podman is compatible to docker and and is the default in Oracle Linux (and some argue it's even better). This is how to install podman:
+Podman is compatible with docker and is the default in Oracle Linux (and some argue it's even better). This is how to install podman:
 
 ```
 sudo yum install docker

diff --git a/content/en/docs/request.md b/content/en/docs/request.md
@@ -44,7 +44,7 @@ If everything is complete you should see this.
 
 ![image](https://user-images.githubusercontent.com/4021595/157341435-4f604137-78f8-46e0-8fbb-a3113f4fac65.png)
 
-You should now be able to select your Compartment (should be named like your
+You should now be able to select your Compartment (which should be named like your
 project) and start using resources.
 
 ![image](https://user-images.githubusercontent.com/4021595/157345820-81a62c95-5603-4bf7-a266-0991fbd9dcb9.png)

diff --git a/content/en/tutorials/notebooks.md b/content/en/tutorials/notebooks.md
@@ -55,7 +55,7 @@ sudo yum update
 sudo yum install ...
 ```
 
-Hint for collaborating with multiple people: Multiple users can log-in to the same notebook system and work on separate notebooks simultaneously, but avoid editing the same notebook file - otherwise you risk overriting your changes:
+Hint for collaborating with multiple people: Multiple users can login to the same notebook system and work on separate notebooks simultaneously, but avoid editing the same notebook file - otherwise you risk overwriting your changes:
 ![image](https://user-images.githubusercontent.com/4021595/159642888-84589148-ed12-42fc-9282-dac7d3b07d5d.png)
 
 
@@ -65,7 +65,7 @@ When completed for the day, you can save costs (especially important when using
 Close the window and hit `Deactivate`
 ![image](https://user-images.githubusercontent.com/4021595/159640588-874f2d3f-1123-41eb-98d1-c5d5b4c222c3.png)
 
-This will shutdown the compute instances but keep your data - so if you want to continue later, a click on `Activate` will bring everything back :)
+This will shut down the compute instances but keep your data - so if you want to continue later, a click on `Activate` will bring everything back :)
 ![image](https://user-images.githubusercontent.com/4021595/159640942-5c8c1599-9e25-45c2-89eb-7de75b4a8b1e.png)
 
 When reactivating you could even change the resources provided for the environment (e.g. adding a GPU or changing to a CPU only environment to save costs) :)

diff --git a/content/en/tutorials/vm.md b/content/en/tutorials/vm.md
@@ -136,7 +136,7 @@ Now it's using the full volume.
 
 ## Terminate the instance
 
-If you don't need the machine anymore, you can `Stop` it (you don't pay for the compute anymore, but the disk stays and you can start it back up later) or `Terminate` it (everthing gets removed, including the bootvolume if you want to):
+If you don't need the machine anymore, you can `Stop` it (you don't pay for the compute anymore, but the disk stays and you can start it back up later) or `Terminate` it (everything gets removed, including the boot volume if you want to):
 
 ![image](https://user-images.githubusercontent.com/4021595/157352624-f3b2b358-1f3d-4388-bf2f-6fc417d4a439.png)