Skip to content

Commit ef36ddd

Browse files
committed
tweaks to devcontainer explanations
2 parents c175913 + 11daa4b commit ef36ddd

File tree

2 files changed

+36
-16
lines changed

2 files changed

+36
-16
lines changed

docs/user/tutorials/devcontainer.rst

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11

2-
Setup the Devcontainer
3-
======================
2+
Setup a Devcontainer
3+
====================
44

55
Introduction
66
------------
77

88
The devcontainer provides the environment in which you will do all your development.
9+
This is a basic tutorial that introduces the concept in preparation for the
10+
epics devcontainer tutorial.
11+
12+
.. seealso:: `epics_devcontainer`
913

1014

1115
Configure Visual Studio Code
@@ -37,22 +41,16 @@ settings editor and search for
3741
Launching the Devcontainer
3842
--------------------------
3943

40-
To setup your devcontainer, perform the following steps:
41-
42-
- create a workspace folder
43-
- clone the .devcontainer repository into the workspace folder
44-
- open the workspace folder with Visual Studio Code.
45-
46-
for example:
44+
If your repository contains a ``.devcontainer`` directory, vscode will be
45+
able to follow the instructions inside and launch a container.
4746

4847
.. code-block:: bash
4948
50-
mkdir work-ec
51-
cd work-ec
52-
git clone [email protected]:epics-containers/.devcontainer.git
49+
git clone <repo>
50+
cd <repo>
5351
code .
5452
55-
This will open the workspace folder in Visual Studio Code. You will be prompted
53+
This will open the project folder in Visual Studio Code. You will be prompted
5654
to reopen the folder in a container. Click on the ``Reopen in Container`` button.
5755

5856
.. figure:: ../images/vscode-reopen-in-container.png

docs/user/tutorials/epics_devcontainer.rst

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,36 @@ The EPICS Devcontainer
55
Introduction
66
------------
77

8-
You can setup a single devcontainer for managing all of your IOCs.
8+
You can setup a single devcontainer for managing all of your IOCs. In
9+
`devcontainer` we launched a devcontainer for a single project. Here we
10+
will create a workspace that is managed by a devcontainer. This will allow
11+
you to manage multiple projects in a single devcontainer.
912

1013
The base container is defined in https://github.com/epics-containers/dev-e7
1114
but we will use a customizable image derived from that. The customizable
1215
container definition is in https://github.com/epics-containers/.devcontainer.
1316

14-
.. seealso:: Basic devcontainer setup: `./devcontainer`
15-
1617

1718
Launching the Devcontainer
1819
--------------------------
1920

21+
To setup your devcontainer, perform the following steps:
22+
23+
- create a workspace folder
24+
- clone the .devcontainer repository into the workspace folder
25+
- open the workspace folder with Visual Studio Code.
26+
27+
for example:
28+
29+
.. code-block:: bash
30+
31+
mkdir work-ec
32+
cd work-ec
33+
git clone [email protected]:epics-containers/.devcontainer.git
34+
code .
35+
36+
.. seealso:: `./devcontainer`
37+
2038
Having setup your devcontainer, to verify things are working as expected,
2139
open a terminal in VSCode from the menus ``Terminal > New Terminal``.
2240
You should see a prompt like this:
@@ -46,6 +64,10 @@ Things to note:
4664
written with your user id and group id when writing to the mounted
4765
workspace folder (or your home directory).
4866

67+
- In the following tutorials we will create further project folders and add
68+
them to the workspace that you have just created. These projects will
69+
all be managed inside the devcontainer we have just set up.
70+
4971
.. _devcontainer-configure:
5072

5173
Configuring the Devcontainer

0 commit comments

Comments
 (0)