cri-dockerd icon indicating copy to clipboard operation
cri-dockerd copied to clipboard

Add to the install docs

Open nwneisen opened this issue 1 year ago • 4 comments

Adds more details to the installation docs. Removes duplicated information from the project's README.md and refers to the official documentation page instead.

nwneisen avatar Mar 08 '24 05:03 nwneisen

Too bad that is has to be an either/or situation, it was nice when the developer information was in the code and the user documentation was at the website...

But I guess the website is also in the code now?

afbjorklund avatar Mar 08 '24 06:03 afbjorklund

I pushed this up to get opinions first. From what I've gathered, we're getting users in the repo who aren't developers and then they try to install using the dev process. The links on the website make the difference more obvious.. I think.

I was also thinking of opening a pr for the k8s web page sending users to the repo to send them to the website instead.

The site was always in the repo in the docs folder. I just changed the wording around how to run it a little.

nwneisen avatar Mar 08 '24 07:03 nwneisen

I was also thinking of opening a pr for the k8s web page sending users to the repo to send them to the website instead.

This was probably the missing piece, and kubernetes wanted to avoid any CR documentation and send people "off-site".

"Items on this page refer to third party products or projects that provide functionality required by Kubernetes. The Kubernetes project authors aren't responsible for those third-party products or projects."

https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/install-kubeadm/#installing-runtime

  • https://kubernetes.io/docs/setup/production-environment/container-runtimes/#docker

  • https://kubernetes.io/dockershim -> https://kubernetes.io/blog/2022/02/17/dockershim-faq/

afbjorklund avatar Mar 08 '24 10:03 afbjorklund

Whether they wanted to or not, they're linking to the repo. I opened a PR to update the links to point to the official documentation: https://github.com/kubernetes/website/pull/45480

nwneisen avatar Mar 08 '24 16:03 nwneisen