Directory

Documentation: Update broken link by SavPhill · Pull Request #41758 · WordPress/gutenberg · GitHub
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

Documentation: Update broken link #41758

Merged
merged 3 commits into from
Jun 13, 2023
Merged

Conversation

SavPhill
Copy link
Contributor

I have removed the link titled 'How do I enable the remote API for dockerd' which points to: https://success.docker.com/article/how-do-i-enable-the-remote-api-for-dockerd as the success.docker.com domain is no longer available.

What?

The documentation reference to success.docker.com is no longer available and therefore this causes a broken link in our own documentation.

Why?

To prevent users accessing a broken link or incorrect link when trying to find addition documentation.

How?

I have looked for an alternative article in docs.docker.com, but I did not find the article or a close match.

Testing Instructions

Screenshots or screencast

I have removed the documentation link to: https://success.docker.com as this domain longer available. This article doesn't appear on the update domain which holds the documentation either (docs.docker.com)
@SavPhill SavPhill changed the title Remove broken link- success.docker.com Documentation: Remove broken link Jun 16, 2022
@alexstine alexstine added the [Type] Developer Documentation Documentation for developers label Jun 16, 2022
@alexstine
Copy link
Contributor

Hmm, this seems tricky to me. I'm not sure we want to be in the business of just showing people how to modify their Docker system files without real links to docs or at least some trustworthy resource. Any of the docs watchers on this PR know if this might be okay for outside linking? I really don't know how that works.

Here are the guidelines set by the Docs Team but not sure if Gutenberg follows similar or different guidelines.
https://make.wordpress.org/docs/style-guide/linking/external-links/

I found this site to give a nice overview.
https://scriptcrunch.com/enable-docker-remote-api/

However, this is not for all operating systems. It seems this is purely a Linux bug.

Some part of me actually wonders if this bug still exists. Kind of odd to see nothing mentioned about it in official docs.

@SavPhill
Copy link
Contributor Author

SavPhill commented Jun 4, 2023

@alexstine Giving this PR a bump as it's 1 year without movement. What action should we take or should we discard this?

@alexstine
Copy link
Contributor

CC: @noahtallen @ObliviousHarmony

@SavPhill SavPhill requested a review from ndiego as a code owner June 12, 2023 03:01
Copy link
Member

@noahtallen noahtallen left a comment

Choose a reason for hiding this comment

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

docs/getting-started/devenv/docker-ubuntu.md Outdated Show resolved Hide resolved
Co-authored-by: Noah Allen <noahtallen@gmail.com>
@SavPhill
Copy link
Contributor Author

I think I found the right link: https://docs.docker.com/config/daemon/remote-access/

Thanks Noah

@noahtallen noahtallen merged commit 11dc8b9 into WordPress:trunk Jun 13, 2023
47 checks passed
@noahtallen noahtallen changed the title Documentation: Remove broken link Documentation: Update broken link Jun 13, 2023
@github-actions github-actions bot added this to the Gutenberg 16.1 milestone Jun 13, 2023
sethrubenstein pushed a commit to pewresearch/gutenberg that referenced this pull request Jul 13, 2023
* Update broken link in docs/getting-started/devenv/docker-ubuntu.md

Co-authored-by: Noah Allen <noahtallen@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants