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

Modification in the post Submit your Block Pattern to the Directory #258

Open
jennydupuy opened this issue Mar 25, 2022 · 5 comments
Open
Labels
[Status] To do Issue marked as Todo user documentation (HelpHub) Improvements or additions to end-user documentation

Comments

@jennydupuy
Copy link

jennydupuy commented Mar 25, 2022

Issue Description

Following the modification of the composition directory header (see: WordPress/pattern-directory@e87d8d5), it would be advisable to modify point 2 in the paragraph "So, how does this work? " in the post "Submit your Block Pattern to the Directory".

URL of the Page with the Issue

https://wordpress.org/support/article/submit-your-block-pattern-to-the-directory/

Section of Page with the issue

Paragraph "So, how does this work?, second item of the list

Why is this a problem?

A direct link to the editor is mentioned, while it is better to give a path to the editor. So if the url of the editor is changed in the future, the documentation will remain correct.
Moreover this link is different for each locale.

Suggested Fix

Replace "After you log in, go to the Pattern Creator page" by
"After you log in, go to the patterns directory, then click on the link Create a new pattern".

@jennydupuy jennydupuy added the tracking issue Use to track a series of related issues. label Mar 25, 2022
@jennydupuy
Copy link
Author

I can do this modification, if you want.

@bph
Copy link

bph commented Mar 25, 2022

@jennydupoy - I don't see that link ever-changing, but who knows.
The downside for the readers is they now need to look for another link on another page. That's the place where they get lost.
If the link does change, I'd rather update the page with the correct link.

@bph bph added user documentation (HelpHub) Improvements or additions to end-user documentation and removed tracking issue Use to track a series of related issues. labels Mar 25, 2022
@bph
Copy link

bph commented Mar 29, 2022

@jennydupuy not sure who strong you feel about this?

@jennydupuy
Copy link
Author

@bph
By indicating a path to follow rather than a direct link, we make sure that when the documentation is translated into a locale, the translator will indicate the label of the "create a new pattern" link of his locale. The user remembers that it is enough to go to the patterns directory to propose a new one. There is no need to go back to the documentation to access the composition editor or to memorize the editor link.
That's just another way of seeing things, not necessarily better than yours. I brought some arguments, maybe see with others what they think.

@jennydupuy
Copy link
Author

@bph
A little repetition here: "You are working Working on your block pattern in the pattern editor."

@zzap zzap added the [Status] To do Issue marked as Todo label Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Status] To do Issue marked as Todo user documentation (HelpHub) Improvements or additions to end-user documentation
Projects
None yet
Development

No branches or pull requests

3 participants