Skip to content
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

Mentioning nuances around the term #21109

Closed
wants to merge 1 commit into from
Closed

Conversation

azarboon
Copy link

@azarboon azarboon commented Oct 12, 2024

Marc Brooker has written a blog post explaining that "container" means different thing to different people, and that it should be checked whether audience and narrator use the same definition. Below are his four suggested definition. Given the authority of Docker, I suggest this nuance to be mentioned. So readers are more informed and take cautionary acts to ensure they are in sync with their audience. It can also prevent confusion / misunderstanding for non-experts. I've added it.

  • An approach to packaging an application along with its dependencies (sometimes a whole operating system user space), that can then run on a minimal runtime environment with a clear contract.
  • A set of development, deployment, architectural, and operational approaches built around applications packaged this way.
  • A set of operational, security, and performance isolation tools that allow multiple applications to share an operating system without interfering with each other. On Linux, this tools include chroot, cgroups, namespaces, seccomp, and others.
  • A set of implementations of these practices (the proper nouns, Docker, Kubernetes, ECS, etc).

Related issues or tickets

Reviews

  • Technical review
  • Editorial review
  • Product review

@github-actions github-actions bot added the area/get-started Relates to get started and onboarding docs label Oct 12, 2024
Copy link

netlify bot commented Oct 12, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 1a31bd4
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/670a2f006986b9000807991a
😎 Deploy Preview https://deploy-preview-21109--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Comment on lines +35 to +36
Note that "container" is an overloaded term. Whenever you use the word, check whether your audience uses the same definition.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is helpful. I think the only thing this does is add ambiguity; these docs are, as you say, authoritative.

@docker-robot
Copy link

docker-robot bot commented Jan 14, 2025

Thanks for the pull request. We'd like to make our product docs better, but haven’t been able to review all the suggestions.
As our docs have also diverged, we do not have the bandwidth to review and rebase old pull requests.

If the updates are still relevant, review our contribution guidelines and rebase your pull request against the latest version of the docs, then mark it as fresh with a /remove-lifecycle stale comment.
If not, this pull request will be closed in 30 days. This helps our maintainers focus on the active pull requests.

Prevent pull requests from auto-closing with a /lifecycle frozen comment.

/lifecycle stale

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/get-started Relates to get started and onboarding docs lifecycle/stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants