Skip to content

Commit 9d161f2

Browse files
committed
chore: make the markdown linter happy
Signed-off-by: Oleksii Kurinnyi <[email protected]>
1 parent 383e9b3 commit 9d161f2

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,28 @@ Containers images with tools for developers 👨‍💻👩‍💻
1313
### Red Hat Universal Base Image ([UBI](https://developers.redhat.com/articles/ubi-faq#)) based images
1414

1515
Available versions:
16-
- **UBI 9**: [quay.io/devfile/base-developer-image:ubi9-latest](https://quay.io/repository/devfile/base-developer-image)
16+
17+
- **UBI 9**: [quay.io/devfile/base-developer-image:ubi9-latest](https://quay.io/repository/devfile/base-developer-image)
1718
- **UBI 10**: [quay.io/devfile/base-developer-image:ubi10-latest](https://quay.io/repository/devfile/base-developer-image)
1819

1920
Run the following commands to test with Docker:
2021

2122
**UBI 9:**
23+
2224
```bash
2325
$ docker run -ti --rm \
2426
quay.io/devfile/base-developer-image:ubi9-latest \
2527
bash
2628
```
2729

2830
**UBI 10:**
31+
2932
```bash
3033
$ docker run -ti --rm \
3134
quay.io/devfile/base-developer-image:ubi10-latest \
3235
bash
3336
```
37+
3438
### Included Development Tools
3539

3640
| Tool | ubi9 based image | ubi10 based image |
@@ -82,8 +86,10 @@ $ docker run -ti --rm \
8286
| **TOTAL SIZE** | **800MB** (255MB compressed) | **789MB** (256MB compressed) |
8387

8488
### Extending the base image
89+
8590
When extending the base image, `source kubedock_setup` should be called in the new image's entrypoint to set up kubedock support. This sets up a wrapper for podman to use kubedock for the following podman commands if the `KUBEDOCK_ENABLED` env variable is set to `true`:
86-
```
91+
92+
```text
8793
podman run
8894
podman ps
8995
podman exec
@@ -97,7 +103,7 @@ podman stop
97103
podman start
98104
```
99105

100-
An example is available in the Universal Developer Image dockerfile [here](https://github.com/devfile/developer-images/blob/main/universal/ubi9/entrypoint.sh#L3).
106+
An example is available in the [Universal Developer Image dockerfile](https://github.com/devfile/developer-images/blob/main/universal/ubi9/entrypoint.sh#L3).
101107

102108
## Developer Universal Image
103109

@@ -106,6 +112,7 @@ An example is available in the Universal Developer Image dockerfile [here](https
106112
**Image:** [quay.io/devfile/universal-developer-image:ubi9-latest](https://quay.io/repository/devfile/universal-developer-image)
107113

108114
**Test:**
115+
109116
```bash
110117
docker run -ti --rm quay.io/devfile/universal-developer-image:ubi9-latest bash
111118
```
@@ -176,16 +183,19 @@ docker run -ti --rm quay.io/devfile/universal-developer-image:ubi9-latest bash
176183
| **TOTAL SIZE** | **8.75GB** (3.6GB compressed) |
177184

178185
**Libraries:**
186+
179187
- e2fsprogs v1.46.5
180188

181189
**Environment Variables:**
190+
182191
- JAVA_HOME_8, JAVA_HOME_11, JAVA_HOME_17, JAVA_HOME_21
183192

184193
### UBI 10 based image
185194

186195
**Image:** [quay.io/devfile/universal-developer-image:ubi10-latest](https://quay.io/repository/devfile/universal-developer-image)
187196

188197
**Test:**
198+
189199
```bash
190200
docker run -ti --rm quay.io/devfile/universal-developer-image:ubi10-latest bash
191201
```
@@ -256,9 +266,11 @@ docker run -ti --rm quay.io/devfile/universal-developer-image:ubi10-latest bash
256266
| **TOTAL SIZE** | **TBD** |
257267

258268
**Libraries:**
269+
259270
- e2fsprogs v1.47.3
260271

261272
**Environment Variables:**
273+
262274
- JAVA_HOME_8, JAVA_HOME_11, JAVA_HOME_17, JAVA_HOME_21, JAVA_HOME_23, JAVA_HOME_25
263275

264276
## Configuration
@@ -270,25 +282,28 @@ The workflows support using custom container registries through the `REGISTRY` e
270282
**Default behavior:** Images are published to `quay.io/devfile`
271283

272284
**To override in a fork:**
285+
273286
1. Go to your repository **Settings****Secrets and Variables****Actions****Variables**
274287
2. Add a repository variable: `REGISTRY` = `your-registry.com/your-namespace`
275288
3. All workflows will automatically use your custom registry
276289

277290
**Example registry formats:**
291+
278292
- `quay.io/youruser`
279-
- `ghcr.io/youruser`
293+
- `ghcr.io/youruser`
280294
- `docker.io/youruser`
281295
- `your-private-registry.com/namespace`
282296

283297
# Builds
284298

285299
This repo contains [actions](https://github.com/devfile/developer-images/actions), including:
286-
* [![release latest stable UBI 9](https://github.com/devfile/developer-images/actions/workflows/ubi9-build.yaml/badge.svg)](https://github.com/devfile/developer-images/actions/workflows/ubi9-build.yaml)
287-
* [![release latest stable UBI 10](https://github.com/devfile/developer-images/actions/workflows/ubi10-build.yaml/badge.svg)](https://github.com/devfile/developer-images/actions/workflows/ubi10-build.yaml)
288300

289-
Downstream builds can be found at the link below, which is _internal to Red Hat_. Stable builds can be found by replacing the 3.x with a specific version like 3.2.
301+
- [![release latest stable UBI 9](https://github.com/devfile/developer-images/actions/workflows/ubi9-build.yaml/badge.svg)](https://github.com/devfile/developer-images/actions/workflows/ubi9-build.yaml)
302+
- [![release latest stable UBI 10](https://github.com/devfile/developer-images/actions/workflows/ubi10-build.yaml/badge.svg)](https://github.com/devfile/developer-images/actions/workflows/ubi10-build.yaml)
303+
304+
Downstream builds can be found at the link below, which is _internal to Red Hat_. Stable builds can be found by replacing the 3.x with a specific version like 3.2.
290305

291-
* [udi_3.x](https://main-jenkins-csb-crwqe.apps.ocp-c1.prod.psi.redhat.com/job/DS_CI/job/udi_3.x)
306+
- [udi_3.x](https://main-jenkins-csb-crwqe.apps.ocp-c1.prod.psi.redhat.com/job/DS_CI/job/udi_3.x)
292307

293308
# License
294309

0 commit comments

Comments
 (0)