From 004e421220903b487d4a203992d5b8945ac06e13 Mon Sep 17 00:00:00 2001
From: Mike McCready <66998419+MikeMcC399@users.noreply.github.com>
Date: Fri, 28 Jun 2024 08:25:26 +0100
Subject: [PATCH] Rework Docker examples page
---
docs/examples/docker.mdx | 32 +++++++++++++++++++++-----------
1 file changed, 21 insertions(+), 11 deletions(-)
diff --git a/docs/examples/docker.mdx b/docs/examples/docker.mdx
index 7be69cdc3a..5f780e4449 100644
--- a/docs/examples/docker.mdx
+++ b/docs/examples/docker.mdx
@@ -7,16 +7,26 @@ sidebar_position: 40
-This repo holds various Docker images for running Cypress locally and in CI.
+This repo holds the documentation, build and publish code for various Docker images for running Cypress locally and in CI.
-The Docker images:
+The following types of Cypress Docker images are available:
-- `cypress/base:` has the operating system dependencies required
- to run Cypress.
-- `cypress/browsers:` extends the base images with pre-installed browsers.
-- `cypress/included:` extends the base images with
- pre-installed Cypress versions.
-- `cypress/factory:` is a docker image that can be used with docker args to
- generate a docker container with specific versions of node, yarn, chrome,
- firefox, edge and cypress. It's used to create the above docker images and can
- be used by you to create a custom docker image with versions of your choice.
+- [cypress/base](https://github.com/cypress-io/cypress-docker-images/tree/master/base)`:`
+ has the operating system dependencies required to run Cypress.
+- [cypress/browsers](https://github.com/cypress-io/cypress-docker-images/tree/master/browsers)`:`
+ extends the base images with pre-installed browsers.
+- [cypress/included](https://github.com/cypress-io/cypress-docker-images/tree/master/included)`:`
+ extends the browsers images with pre-installed Cypress versions.
+- [cypress/factory](https://github.com/cypress-io/cypress-docker-images/tree/master/factory)`:`
+ is a Docker image that can be used with [`ARG`](https://docs.docker.com/reference/dockerfile/#arg) instructions
+ in a custom-built [`Dockerfile`](https://docs.docker.com/reference/dockerfile/) to generate a new Docker image
+ with specific versions of Node.js, Yarn v1 Classic, Chrome, Firefox, Edge and Cypress.
+ It's used to create the above Docker images and can
+ be used by you to create a custom Docker image with versions of your choice.
+
+## Examples
+
+- See [CI Docker examples](../guides/continuous-integration/introduction#CI-Docker-examples)
+ for examples of using Cypress Docker images in Continuous Integration (CI)
+- See [Docker usage examples](https://github.com/cypress-io/cypress-docker-images/blob/master/README.md#examples)
+ in the [cypress-io/cypress-docker-images](https://github.com/cypress-io/cypress-docker-images) repo