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

Fix broken links in editor documentation #51321

Merged
merged 3 commits into from
Jun 12, 2023

Conversation

derekblank
Copy link
Member

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.

@derekblank derekblank added the [Type] Developer Documentation Documentation for developers label Jun 8, 2023
@github-actions
Copy link

github-actions bot commented Jun 8, 2023

Flaky tests detected in aa1c9c3.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5216025692
📝 Reported issues:

Copy link
Contributor

@fluiddot fluiddot left a comment

Choose a reason for hiding this comment

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

LGTM 🎊 !

@t-hamano t-hamano self-requested a review June 11, 2023 08:47
Copy link
Contributor

@t-hamano t-hamano left a 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?

@derekblank
Copy link
Member Author

@t-hamano Thanks for reviewing, and great suggestion! I agree that linking to GitHub would likely be more stable. I've updated the docs. 👍

@t-hamano t-hamano self-requested a review June 12, 2023 04:22
Copy link
Contributor

@t-hamano t-hamano left a 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 👍

@derekblank derekblank merged commit 1746e8c into trunk Jun 12, 2023
@derekblank derekblank deleted the rnmobile/docs/fix-broken-links branch June 12, 2023 04:43
@github-actions github-actions bot added this to the Gutenberg 16.1 milestone Jun 12, 2023
@bph bph added the Mobile App - Release PRs for native mobile editor releases label Jun 12, 2023
sethrubenstein pushed a commit to pewresearch/gutenberg that referenced this pull request Jul 13, 2023
* Fix broken links in editor documentation

* Use references to Appium 1.x docs

* Update Appium documentation to link to GitHub
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Mobile App - Release PRs for native mobile editor releases [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants