Skip to content

Commit 564eb0d

Browse files
committed
Review "Four ways to use repo2docker images" page
1 parent 1a67731 commit 564eb0d

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

docs/source/use/pathways.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,21 +41,21 @@ This is not the same thing as forking the repository for the community image, mo
4141
:::{grid-item-card} Benefits
4242

4343
- 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]
4747
:::
4848
:::{grid-item-card} Drawbacks
4949
- Need to understand how upstream image is built so you can customize
5050
- Documentation for this method currently sucks (but can be fixed!)
5151
- Removing existing packages might break things
52-
- You must manage a GH repo
52+
- You must manage a Git repository
5353
:::
5454
::::
5555

5656
See [](./extend-community-image.md) for a how-to guide.
5757

58-
## 3. Use repo2docker to build your environment image
58+
## 3. Use `repo2docker` to build your environment image
5959

6060
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).
6161
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
6464
::::{grid} 2
6565
:::{grid-item-card} Benefits
6666

67-
- Works well with mybinder.org
67+
- Works well with [mybinder.org]
6868
- No need to learn Dockerfile syntax
6969
- Use language specific, well understood file formats
7070
- Only get whatever packages you want
@@ -79,7 +79,7 @@ Check out the other sections under "Image building basics" for more useful how-t
7979

8080
## 4. Use a full fledged custom Dockerfile
8181

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.
8383

8484
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.
8585

@@ -90,13 +90,15 @@ This is for advanced users only that know what they're doing - full guidance on
9090

9191
- Get exactly what you want
9292
- 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
9494

9595
:::
9696
:::{grid-item-card} Drawbacks
9797

9898
- Requires a lot of knowledge for ongoing maintenance
9999
- 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
101101
:::
102102
::::
103+
104+
[mybinder.org]: https://mybinder.org

0 commit comments

Comments
 (0)