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] Content review for Creating a Search page #430

Closed
1 task
Tracked by #834
estelaris opened this issue Sep 1, 2022 · 9 comments
Closed
1 task
Tracked by #834

[HelpHub] Content review for Creating a Search page #430

estelaris opened this issue Sep 1, 2022 · 9 comments
Assignees
Labels
Content Review good first issue Good for newcomers [Status] Done Issue is completed user documentation (HelpHub) Improvements or additions to end-user documentation

Comments

@estelaris
Copy link
Member

Issue Description

The page is focused on developer information but needs to refocus for Helphub end-users.

URL of the Page with the Issue

Creating a search page

Section of Page with the issue

full article

Why is this a problem?

developer jargon/content review

Suggested Fix

  • Review and update content in the context of the Site Editor
@estelaris estelaris added tracking issue Use to track a series of related issues. user documentation (HelpHub) Improvements or additions to end-user documentation Content Review and removed tracking issue Use to track a series of related issues. labels Sep 1, 2022
@github-actions
Copy link

github-actions bot commented Sep 1, 2022

Heads up @femkreations @atachibana - the "user documentation" label was applied to this issue.

@estelaris estelaris added the good first issue Good for newcomers label Sep 8, 2022
@estelaris estelaris changed the title Content review for Creating a Search page [Helphub] Content review for Creating a Search page Sep 15, 2022
@estelaris estelaris changed the title [Helphub] Content review for Creating a Search page [HelpHub] Content review for Creating a Search page Sep 15, 2022
@hannaw93 hannaw93 assigned hannaw93 and unassigned hannaw93 Apr 5, 2023
@emmyoungg
Copy link

I will work on this one

@pekkakortelainen
Copy link

pekkakortelainen commented Sep 14, 2023

As discussed in Slack during triage on 12th September 2023, I'll work on this.

@zzap zzap added the [Status] In progress Issue is in progress label Oct 2, 2023
@sagargurnani99
Copy link
Collaborator

/assign

Copy link

Hey @sagargurnani99, this issue is already assigned to @pekkakortelainen.
A maintainer can also add you to the list of assignees or swap you with the current assignee. Or you can take a look at other unassigned issues we have.

@sagargurnani99
Copy link
Collaborator

sagargurnani99 commented Jan 21, 2024

We can remove all the jargon from the article and replace it with the one I suggest below.

Create a search page

A Search Page is a WordPress Page with a custom Page template to give users more information for searching your site.

How to create it?

  1. On the Admin Area go to Pages > Add New.
  2. In the title field enter Search.
  3. Add a new block named "Search".
  4. Publish the page.

How to test it?

  1. Leave the Admin Area and go to the User Area.
  2. Click on the Search link from the Menu to land on the newly created Search page.
  3. In the search field, type the keyword to search and submit.
  4. The search results must appear on the same page.
  5. If no post is found with the keyword then "No posts were found." message would appear.
create-search-page.mov

@sagargurnani99 sagargurnani99 added [Status] Review Issue in review and removed [Status] In progress Issue is in progress labels Jan 21, 2024
Copy link

Heads up @docs-reviewers - the "[Status] Review" label was applied to this issue.

@Leonardus-Nugraha
Copy link
Collaborator

Hiya @sagargurnani99
I think the opening sentence on your draft can be replaced as it's repeating the opening sentence of the article (A Search Page is a WordPress Page with a custom Page template to give users more information for searching your site.)

I would suggest something like "Follow these steps to create a search page using the the custom page template:"

Other than that, this draft is ready to go!

@sagargurnani99
Copy link
Collaborator

sagargurnani99 commented Mar 18, 2024

Thanks @Leonardus-Nugraha, I have updated the article as per your suggestion. The developer jargon has been removed.
Closing the issue now.

@github-actions github-actions bot added [Status] Done Issue is completed and removed [Status] Review Issue in review labels Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content Review good first issue Good for newcomers [Status] Done Issue is completed user documentation (HelpHub) Improvements or additions to end-user documentation
Projects
None yet
Development

No branches or pull requests

9 participants