-
Notifications
You must be signed in to change notification settings - Fork 377
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: align terms in factory readme #1116
docs: align terms in factory readme #1116
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
@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. |
It's quite tricky to automate, since many terms have different capitalization depending on the context e.g. "Yarn" as the package manager, |
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 aDockerfile
.Branded names are referred to with incorrect capitalization.
Image / Container Image
Container
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