|
1 | | -# Gitpod |
| 1 | +# GitHub Codespaces |
2 | 2 |
|
3 | | -Gitpod 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 efficiently and securely develop software. It can improve your developer experience by coding in a cloud development environment. |
4 | 4 |
|
5 | 5 | ## Creating a Gitpod account |
6 | 6 |
|
7 | | -You can create a free [Gitpod](https://gitpod.io/) account using your GitLab, GitHub, or Bitbucket account. |
| 7 | +You can create a free GitHub account from the [GitHub home page](https://github.com/). |
8 | 8 |
|
9 | | -You can create an account using the [Gitpod login page](https://gitpod.io/login/). |
| 9 | +## Running GitHub Codespaces |
10 | 10 |
|
11 | | - |
| 11 | +Once you are logged in to GitHub, open this link in your browser to open the training environment: <https://codespaces.new/nextflow-io/training?quickstart=1&ref=master> |
12 | 12 |
|
13 | | -It is best to connect your LinkedIn account to receive a full 50 hours usage allocation. |
| 13 | +Alternatively, you can click on the button below. |
14 | 14 |
|
15 | | - |
| 15 | +[](https://codespaces.new/nextflow-io/training?quickstart=1&ref=master) |
16 | 16 |
|
17 | | -After selecting your preferred editor, theme, and profile details, click continue and your account will be created and ready to use. |
| 17 | +You should be presented with a page where you can create a new GitHub Codespace: |
18 | 18 |
|
19 | | -!!! note |
| 19 | + |
20 | 20 |
|
21 | | - It is recommended to use the VS code editor. |
| 21 | +If you wish, you can click "Change options" to configure the machine used, though the defaults should be fine. |
22 | 22 |
|
23 | | -## Running Gitpod |
| 23 | +!!! warning |
24 | 24 |
|
25 | | -Click the following URL to run Gitpod: <https://gitpod.io/#https://github.com/nextflow-io/training> |
| 25 | + 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. |
26 | 27 |
|
27 | | -This URL is the Nextflow training repository prefixed with `https://gitpod.io/#`. |
| 28 | +## Explore your GitHub Codespaces IDE |
28 | 29 |
|
29 | | -Alternatively, you can click on the button below. |
| 30 | +After GitHub Codespaces has loaded, you should see something similar to the following (which may in light mode depending on your account preferences): |
30 | 31 |
|
31 | | -[](https://gitpod.io/#https://github.com/nextflow-io/training) |
| 32 | + |
32 | 33 |
|
33 | | -If you are already logged in, your Gitpod environment will start to load. |
| 34 | +This is the interface of the VSCode IDE, a popular code development application that we recommend using for Nextflow development. |
34 | 35 |
|
35 | | -### Explore your Gitpod IDE |
| 36 | +- **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. |
| 37 | +- **The terminal** allows you to run all the programs in the repository. For example, both `nextflow` and `docker` are installed and can be executed. |
| 38 | +- **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. |
36 | 40 |
|
37 | | -After Gitpod has loaded, you should see something similar to the following: |
| 41 | +## Reopening a GitHub Codespaces session |
38 | 42 |
|
39 | | - |
| 43 | +Once you have created an envionrment, you can easily resume or restart it and continue from where you left off. |
40 | 44 |
|
41 | | -- **The sidebar** allows you to customize your Gitpod 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. |
42 | | -- **The terminal** allows you to run all the programs in the repository. For example, both `nextflow` and `docker` are installed and can be executed. |
43 | | -- **The file explorer** allows you to view and edit files. Clicking on a file in the explorer will open it within the main window. |
44 | | -- **The Simple Browser** lets you view the nf-training material browser (<https://training.nextflow.io/>). If you close it by accident, you can load the simple browser again by typing the following in the terminal: `gp preview https://training.nextflow.io`. |
| 45 | +You can reopen an environment from <https://github.com/codespaces/>. Previous environments will be listed. Click a session to resume it. |
45 | 46 |
|
46 | | -### Gitpod resources |
| 47 | + |
47 | 48 |
|
48 | | -Gitpod gives you 500 free credits per month, which is equivalent to 50 hours of free environment runtime using the standard workspace (up to 4 cores, 8 GB RAM, and 30 GB storage). |
| 49 | +If you have saved the URL for your previous Gitpod environment, you can simply open it in your browser. |
49 | 50 |
|
50 | | -There is also a large workspace option that gives you up to 8 cores, 16GB RAM, and 50GB storage. However, the large workspace will use your free credits quicker and you will have fewer hours of access to this space. |
| 51 | +Alternatively, click the same button that you used to create it in the first place: |
51 | 52 |
|
52 | | -Gitpod will time out after 30 minutes of inactivity and will save your changes for up to 2 weeks. |
| 53 | +[](https://codespaces.new/nextflow-io/training?quickstart=1&ref=master) |
53 | 54 |
|
54 | | -More information about Gitpod is available at [gitpod.io](https://www.gitpod.io). |
| 55 | +You should see the previous session, the default option is to resume it: |
55 | 56 |
|
56 | | -### Reopening a Gitpod session |
| 57 | + |
57 | 58 |
|
58 | | -You can reopen an environment from <https://gitpod.io/workspaces>. Previous environments will be listed. You can select the ellipsis (three dots icon) and then select `Open` to reopen a previous environment. |
| 59 | +## GitHub Codespaces billing |
59 | 60 |
|
60 | | -If you have saved the URL for your previous Gitpod environment, you can simply open it in your browser. |
| 61 | +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. |
| 65 | + |
| 66 | +GitHub Codespaces will time out after 30 minutes of inactivity and will save your changes for up to 2 weeks. |
61 | 67 |
|
62 | | -Alternatively, you can open a new training workspace by following the Gitpod URL: <https://gitpod.io/#https://github.com/nextflow-io/training> |
| 68 | +More information can be found in the GitHub docs: |
| 69 | +[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) |
63 | 70 |
|
64 | | -### Saving files from Gitpod to your local machine |
| 71 | +### Saving files from GitHub Codespaces to your local machine |
65 | 72 |
|
66 | 73 | To save any file from the explorer panel, right-click the file and select `Download`. |
0 commit comments