Skip to content

Commit 9070df7

Browse files
committed
Added a few details to the codespaces setup instructions
1 parent 0653dfe commit 9070df7

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

docs/envsetup/01_setup.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# GitHub Codespaces
22

3-
GitHub Codespaces is a cloud development environment for teams to efficiently and securely develop software. It can improve your developer experience by coding in a cloud development environment.
3+
GitHub Codespaces is a cloud development environment for teams to develop software efficiently and securely.
4+
We use it as a training environment because it allows us to provide learners with a consistent and thoroughly tested environment.
45

56
## Creating a GitHub account
67

@@ -18,12 +19,18 @@ You should be presented with a page where you can create a new GitHub Codespace:
1819

1920
![Create a GitHub Codespace](img/codespaces_create.png)
2021

21-
If you wish, you can click "Change options" to configure the machine used, though the defaults should be fine.
22+
You can click "Change options" to configure the machine used.
23+
Using a machine with more cores allows you to take greater advantage of Nextflow's ability to parallelize workflow execution.
24+
25+
**For our Hello Nextflow and Nextflow For Science training courses, we recommend using a 4-core machine.**
26+
27+
The free Github plan includes 120 core-hours of Codespaces compute per month, which amounts to 30 hours of a 4-core machine.
28+
(See below for more information about quotas.)
2229

2330
!!! warning
2431

2532
Opening a new GitHub Codespaces environment for the first time can take several minutes.
26-
It's worth grabbing a cup of tea and checking your emails.
33+
Just enough time to brew a cup of tea and check your emails, or go over the intro materials if you're in a group training.
2734

2835
## Explore your GitHub Codespaces IDE
2936

@@ -36,18 +43,20 @@ This is the interface of the VSCode IDE, a popular code development application
3643
- **The sidebar** allows you to customize your GitHub Codespaces environment and perform basic tasks (copy, paste, open files, search, git, etc.). You can click the explorer button to see which files are in this repository.
3744
- **The terminal** allows you to run all the programs in the repository. For example, both `nextflow` and `docker` are installed and can be executed.
3845
- **The file explorer** allows you to view and edit files. Clicking on a file in the explorer will open it within the main window.
39-
- **The main editor** showing you a preview of the `README.md` file.
46+
- **The main editor** showing you a preview of the `README.md` file. When you open code or data files, they will open there.
4047

4148
## Reopening a GitHub Codespaces session
4249

43-
Once you have created an envionrment, you can easily resume or restart it and continue from where you left off.
50+
Once you have created an environment, you can easily resume or restart it and continue from where you left off.
51+
Your environment will time out after 30 minutes of inactivity and will save your changes for up to 2 weeks.
4452

45-
You can reopen an environment from <https://github.com/codespaces/>. Previous environments will be listed. Click a session to resume it.
53+
You can reopen an environment from <https://github.com/codespaces/>.
54+
Previous environments will be listed.
55+
Click a session to resume it.
4656

4757
![List GitHub Codespace sessions](img/codespaces_list.png)
4858

4959
If you have saved the URL for your previous GitHub Codespaces environment, you can simply open it in your browser.
50-
5160
Alternatively, click the same button that you used to create it in the first place:
5261

5362
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/nextflow-io/training?quickstart=1&ref=master)
@@ -56,14 +65,14 @@ You should see the previous session, the default option is to resume it:
5665

5766
![Resume a GitHub Codespace](img/codespaces_resume.png)
5867

59-
## GitHub Codespaces billing
68+
## GitHub Codespaces quotas
6069

6170
GitHub Codespaces gives you up to 15 GB-month storage per month, and 120 core-hours per month.
62-
This is equivalent to around 60 hours of free environment runtime using the standard workspace (up to 2 cores, 8 GB RAM, and 32 GB storage).
63-
64-
GitHub Codespaces environments are configurable. You can create them with more resources, but this will use your free usage quicker and you will have fewer hours of access to this space.
71+
This is equivalent to around 60 hours of the default environment runtime using the standard workspace (up to 2 cores, 8 GB RAM, and 32 GB storage).
6572

66-
GitHub Codespaces will time out after 30 minutes of inactivity and will save your changes for up to 2 weeks.
73+
GitHub Codespaces environments are configurable.
74+
You can create them with more resources, but this will consume your free usage faster and you will have fewer hours of access to this space.
75+
Optionally, you can purchase access to more resources.
6776

6877
More information can be found in the GitHub docs:
6978
[About billing for GitHub Codespaces](https://docs.github.com/en/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)

0 commit comments

Comments
 (0)