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

[HelpHub] Change article titles #192

Closed
49 tasks done
Tracked by #834
estelaris opened this issue Mar 1, 2022 · 4 comments
Closed
49 tasks done
Tracked by #834

[HelpHub] Change article titles #192

estelaris opened this issue Mar 1, 2022 · 4 comments
Assignees
Labels
needs discussion Issue that need discussion and team's decision. Will be discussed at the meeting. re-categorization project Part of the re-categorizaton project user documentation (HelpHub) Improvements or additions to end-user documentation

Comments

@estelaris
Copy link
Member

estelaris commented Mar 1, 2022

There are new title recommendations as part of the GSoD.

Issue Description

The issue is broken into several parts so we can better keep track of all changes

URL of the Page with the Issue

See list below

Section of Page with the issue

Title and sometimes the URL

Why is this a problem?

Title needs to follow the guidelines as written during GSoD

This fix is part of the recategorization project. Our goal is to reorganize the end-user articles in HelpHub in order to make them easier to find and more accessible to the end-user.
Articles will be merged, removed, updated and added to a new category.
For more information reach out to @estelaris on Slack - docs channel.

Suggested Fix

@estelaris estelaris added the tracking issue Use to track a series of related issues. label Mar 1, 2022
@estelaris estelaris self-assigned this Mar 1, 2022
@estelaris estelaris added needs discussion Issue that need discussion and team's decision. Will be discussed at the meeting. re-categorization project Part of the re-categorizaton project user documentation (HelpHub) Improvements or additions to end-user documentation and removed tracking issue Use to track a series of related issues. labels Mar 1, 2022
@theMikeD
Copy link

theMikeD commented Mar 9, 2022

Some thoughts

[ ] Post Status > Set post status
This page is not about setting a post status. It is about post status' generally. The new title is misleading and inaccurate. Elsewhere you use "Use" for this purpose, that would be a better choice here.

All of these could start with "Learn about..." or "How to..." so why are they applied only to two titles? I assume it's in service of the "use action words first" template for titles that appears to be in place here. Those should be re-thought. Following the pattern of present participle to simple present in other places, "Installing WordPress" should be "Install WordPress" not "How to install WordPress."

@estelaris
Copy link
Member Author

Thanks for the comment @theMikeD. We are avoiding the How-to's on purpose, so I will remove the How to.. from that title. The Post Status, you are correct, it should be Use Post Status or What is Post Status?

@estelaris estelaris changed the title Change article titles part 1 [HelpHub] Change article titles Sep 27, 2022
@estelaris estelaris mentioned this issue Oct 18, 2022
7 tasks
@estelaris
Copy link
Member Author

All changes have been made in the /documentation-test/ site, will close ticket as soon as the migration is finished.

@estelaris
Copy link
Member Author

All articles were redirected under the url wp.org/documentation/article/new-title

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs discussion Issue that need discussion and team's decision. Will be discussed at the meeting. re-categorization project Part of the re-categorizaton project user documentation (HelpHub) Improvements or additions to end-user documentation
Projects
None yet
Development

No branches or pull requests

2 participants