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

#1281 docker machine link redirects to docker desktop documentation #1286

Conversation

martyav
Copy link
Contributor

@martyav martyav commented May 14, 2024

Fixes #1281

Reminders

  • See the README for more details on how to work with the Rancher docs.

  • Verify if changes pertain to other versions of Rancher. If they do, finalize the edits on one version of the page, then apply the edits to the other versions.

  • If the pull request is dependent on an upcoming release, make sure to target the release branch instead of main.

Description

Upon investigating the original problem, learned that:

  1. Docker deprecated Docker Machine in 2021
  2. Docker now redirects visitors seeking docs about Docker Machine to docs about Docker Desktop
  3. Rancher (the org) maintains its own fork of Docker Machine and it is used within Rancher (the software)
  4. The Rancher Machine fork links to the original Docker Machine documentation the link intended to point to

Comments

Original comment from #1281:

I did a little research. The Docker Machine repo is now archived and the project is deprecated.

From docker/machine#4894 (comment):

We are not actively maintaining this project and see Docker Desktop as its successor for container development on macOS and Windows. I've added an item on our docker/roadmap#245 where you can leave us feedback.

From docker/roadmap#245:

The Docker Machine project started in 2014 to make it easier to setup and run Docker in a virtual machine. One of the major use cases for this was to make it easier to use Docker on macOS and Windows. Since its release in 2016, Docker Desktop has been seen as the replacement for Docker Machine to develop with containers on macOS and Windows. Not only does Docker Desktop provide a Docker API endpoint but it also provides transparent handling of file sharing and networking between the host and VM which make container development easier.

Rancher: Node Drivers contains a link to https://docs.docker.com/machine/ but that page has been removed and the Docker site redirects visitors to https://docs.docker.com/desktop/ instead.

Curiously enough, Rancher maintains its own fork of Docker Machine at https://github.com/rancher/machine. The README on that repo points to https://gcbw.github.io/docker.github.io/machine/, a mirror of the original Docker Machine docs.

The Rancher fork notes:

This project is intended to be embedded and executed by the full Rancher product and the stand alone cli functionality will remain but the human use of it will not be the primary focus as we will expect inputs provided by other things like Terraform or UIs.

@martyav martyav added the sync-versions Reminder to sync versioned pages label May 14, 2024
@martyav martyav requested a review from jiaqiluo May 14, 2024 14:37
@martyav martyav removed the sync-versions Reminder to sync versioned pages label May 14, 2024
Copy link
Contributor

@btat btat left a comment

Choose a reason for hiding this comment

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

The proposed URL looks like a fork of the repo hosted on a personal (someone outside of SUSE?) GitHub pages site.

We should point to the GitHub source instead https://github.com/docker/docs/blob/vnext-engine/machine/overview.md.

Co-authored-by: Billy Tat <btat@suse.com>
@martyav martyav requested a review from btat May 15, 2024 14:42
@martyav martyav merged commit 5bf5c87 into rancher:main May 15, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docker machine link redirects to Docker Desktop documentation
4 participants