-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Fix broken links in editor documentation #51321
Conversation
Flaky tests detected in aa1c9c3. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5216025692
|
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.
LGTM 🎊 !
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.
Thanks for the PR, @derekblank.
While reviewing this PR, I found another broken link regarding Appium:
- [Appium CLI](https://appium.io/docs/en/about-appium/getting-started/) installed and available globally. We also recommend using [appium-doctor](https://github.com/appium/appium-doctor) to ensure all of Appium's dependencies are good to go. You don't have to worry about starting the server yourself, the tests handle starting the server on port 4723, just be sure that the port is free or feel free to change the port number in the test file. |
Instead of https://appium.io/docs/en/about-appium/getting-started/, https://github.com/appium/appium/blob/1.x/docs/en/about-appium/getting-started.md may be the currently valid link.
If you would like, how about responding with this PR?
@t-hamano Thanks for reviewing, and great suggestion! I agree that linking to GitHub would likely be more stable. I've updated the docs. 👍 |
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.
LGTM! Thanks for the update 👍
* Fix broken links in editor documentation * Use references to Appium 1.x docs * Update Appium documentation to link to GitHub
What?
Fixes a handful of broken links in the Editor documentation.
Why?
To encourage external code contributions, and also not have broken links in documentation.
How?
Finds and replaces the related updated link URL for broken links.
Testing Instructions
Referenced documentation links should not 404.