You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/use/pathways.md
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,21 +41,21 @@ This is not the same thing as forking the repository for the community image, mo
41
41
:::{grid-item-card} Benefits
42
42
43
43
- Only need to maintain the changes you make
44
-
- Update the FROM tag to keep up with upstream changes
45
-
- You must manage a GH repo
46
-
- Works well with mybinder.org
44
+
- Update the `FROM` tag to keep up with upstream changes
45
+
- You must manage a Git repository
46
+
- Works well with [mybinder.org]
47
47
:::
48
48
:::{grid-item-card} Drawbacks
49
49
- Need to understand how upstream image is built so you can customize
50
50
- Documentation for this method currently sucks (but can be fixed!)
51
51
- Removing existing packages might break things
52
-
- You must manage a GH repo
52
+
- You must manage a Git repository
53
53
:::
54
54
::::
55
55
56
56
See [](./extend-community-image.md) for a how-to guide.
57
57
58
-
## 3. Use repo2docker to build your environment image
58
+
## 3. Use `repo2docker` to build your environment image
59
59
60
60
If your needs differ far enough from the community-maintained images that you find, you can use `repo2docker` to build your environment image using [supported configuration files](#config-files).
61
61
To learn how to do this, follow the [getting started with repo2docker guide](../start.md) and look at the [list of supported configuration files](#config-files).
@@ -64,7 +64,7 @@ Check out the other sections under "Image building basics" for more useful how-t
64
64
::::{grid} 2
65
65
:::{grid-item-card} Benefits
66
66
67
-
- Works well with mybinder.org
67
+
- Works well with [mybinder.org]
68
68
- No need to learn Dockerfile syntax
69
69
- Use language specific, well understood file formats
70
70
- Only get whatever packages you want
@@ -79,7 +79,7 @@ Check out the other sections under "Image building basics" for more useful how-t
79
79
80
80
## 4. Use a full fledged custom Dockerfile
81
81
82
-
If you need full control over the entire computational environment, you can always create your own `Dockerfile` from scratch, and repo2docker will build an image out of it.
82
+
If you need full control over the entire computational environment, you can always create your own `Dockerfile` from scratch, and `repo2docker` will build an image out of it.
83
83
84
84
This is for advanced users only that know what they're doing - full guidance on how to use `Dockerfiles` is out of scope for this tutorial.
85
85
@@ -90,13 +90,15 @@ This is for advanced users only that know what they're doing - full guidance on
90
90
91
91
- Get exactly what you want
92
92
- Can be optimized for small image size & fast build times
93
-
- Lots of existing documentation in the SRE world on how to use these
93
+
- Lots of existing documentation in the site reliability engineer world on how to use these
94
94
95
95
:::
96
96
:::{grid-item-card} Drawbacks
97
97
98
98
- Requires a lot of knowledge for ongoing maintenance
99
99
- Might have to solve problems yourself that were solved in upstream images / repo2docker
100
-
- Need to adapt existing documentation from the SRE use case to interactive computing use case
100
+
- Need to adapt existing documentation from the site reliability engineer use case to interactive computing use case
0 commit comments