docs: align terms in factory readme

[MikeMcC399]

Issues

Use of terms in factory/README is not consistent.

The term "container" does not conform to the Docker glossary definition. The build process results in a read-only "image", whereas the run process creates a read/write "container". A Docker "image" is sometimes also referred to as a "container image".

Different terms args / ARG / env are used when referring to ARG parameters used in a Dockerfile.

Branded names are referred to with incorrect capitalization.

Image / Container Image

Docker images are the basis of containers. An Image is an ordered collection of root filesystem changes and the corresponding execution parameters for use within a container runtime. An image typically contains a union of layered filesystems stacked on top of each other. An image does not have state and it never changes.

Container

A container is a runtime instance of a docker image.

A Docker container consists of

• A Docker image
• An execution environment
• A standard set of instructions

Change

• Use of the terms "container" and "image" are aligned to the Docker glossary definition.

• The term ARG is harmonized.

• Branding capitalization / naming is corrected.

• "Yarn" is changed to "Yarn v1 Classic" to avoid confusion that the term Yarn could be referring to "Yarn Modern (v2 - v4)".

References

• https://www.docker.com/legal/trademark-guidelines/
• https://docs.docker.com/reference/dockerfile/#arg
• https://nodejs.org/en/about
• https://classic.yarnpkg.com/en/docs
• https://www.google.com/chrome/
• https://www.mozilla.org/en-US/firefox
• https://www.microsoft.com/en-us/edge
• https://www.cypress.io/

[cypress-app-bot]

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.

[MikeMcC399]

Preview

https://github.com/MikeMcC399/cypress-docker-images/blob/factory-terms-alignment/factory/README.md

[MikeMcC399]

@jennifer-shehane

Nice. I like to have correct capitalization and terms. ☺️

The main point was to correct the mixed up usage of "container" and "image". It seemed also like the right opportunity to clean up a few other things.

There is still quite a bit of documentation work to do here. Ultimately updates are also needed in other repos like https://github.com/cypress-io/cypress-documentation & https://github.com/cypress-io/cypress-example-recipes. The descriptions on https://hub.docker.com/u/cypress will need some updates as well. One thing has led to another here. Originally I only set out to update cypress/factory to Debian 12. 🙂

[jennifer-shehane]

@MikeMcC399 We used to have a linter on our docs that would correct improper uses of terms based on our defintions of what to replace them with. I wish we hadnt gotten rid of it.

[MikeMcC399]

@jennifer-shehane

We used to have a linter on our docs that would correct improper uses of terms based on our defintions of what to replace them with. I wish we hadnt gotten rid of it.

It's quite tricky to automate, since many terms have different capitalization depending on the context e.g. "Yarn" as the package manager, yarn as the command. If the existing texts are consistent then there's a higher chance that authors will use this as an example for new text submissions. Probably there is no escaping getting it right and checking it manually!