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

Sidebar: update post editor help links to use newer documentation #39688

Merged

Conversation

arcangelini
Copy link
Contributor

What?

There are two links to WordPress.org documentation that I believe could be better linked. I am proposing to change:

From To
https://wordpress.org/support/article/excerpt/ https://wordpress.org/support/article/settings-sidebar/#excerpt
https://wordpress.org/support/article/writing-posts/#post-field-descriptions https://wordpress.org/support/article/settings-sidebar/#permalink

Why?

Permalink

This link is currently a bit out of date as it pertains to the Classic editor. The article gives very few information to the user about the component they just clicked on. The link gives context to the exact element they clicked on and has links to more details if they want.

Excerpt

While the link is relevant in general and up-to-date, the new link provides a better summary and is within the context of the element they just clicked. This new article also has links to the previous one in case the user wants more details.

How?

Manually change the URL for each component.

Testing Instructions

  1. Go to the editor
  2. In the sidebar click the help links
  3. You should go to the new articles

Screenshots or screencast

Markup 2022-03-23 at 13 01 08

@github-actions
Copy link

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @arcangelini! In case you missed it, we'd love to have you join us in our Slack community, where we hold regularly weekly meetings open to anyone to coordinate with each other.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Mar 23, 2022
Copy link
Contributor

@talldan talldan 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 doing this and congrats on your first contribution 🎉

@talldan talldan merged commit 94ba76a into WordPress:trunk Mar 24, 2022
@talldan talldan added [Type] Developer Documentation Documentation for developers [Package] Edit Post /packages/edit-post labels Mar 24, 2022
@talldan talldan changed the title Sidebar: update help links Sidebar: update post editor help links to use newer documentation Mar 24, 2022
@github-actions
Copy link

Congratulations on your first merged pull request, @arcangelini! We'd like to credit you for your contribution in the post announcing the next WordPress release, but we can't find a WordPress.org profile associated with your GitHub account. When you have a moment, visit the following URL and click "link your GitHub account" under "GitHub Username" to link your accounts:

https://profiles.wordpress.org/me/profile/edit/

And if you don't have a WordPress.org account, you can create one on this page:

https://login.wordpress.org/register

Kudos!

@github-actions github-actions bot added this to the Gutenberg 13.0 milestone Mar 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Package] Edit Post /packages/edit-post [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants