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

Installation section doesn't contain relevant installation information. #1466

Closed
StevenDufresne opened this issue Feb 22, 2024 · 18 comments
Closed
Assignees
Labels
[Status] Done Issue is completed

Comments

@StevenDufresne
Copy link

StevenDufresne commented Feb 22, 2024

Issue Description

The "installation" section is the second most visited (20% of sessions) section of the docs. This is the current list of documentation in that category:

Hosting WordPress (40% of pageviews happen here next)
Optimization (7% of pageviews happen here next)
Search Engine Optimization (2% of pageviews happen here next)
Troubleshoot login issues (2% of pageviews happen here next)
Use automated installation(12% of pageviews happen here next)

Most people click through on "Hosting WordPress" with 30% of those users backtracking immediately.

URL of the Page with the Issue

(https://wordpress.org/documentation/category/installation/)

Section of Page with the issue

The whole page.

Why is this a problem?

The Installation section states that it will help you install but does not include any content for helping you install WordPress.

Header Header
Screenshot 2024-02-22 at 1 35 00 PM Screenshot 2024-02-22 at 1 35 28 PM

*Data taken from Jan 1, 2023 to May 1, 2023.

Suggested Fix

I think we need to thoughtfully rethink this page. It's really important. As a first step, let's add a link to the page in the first position "Install WordPress" and link it to https://developer.wordpress.org/advanced-administration/before-install/howto-install/.

Making the page read:

Install WordPress
Hosting WordPress
Optimization
Search Engine Optimization
Troubleshoot login issues
Use automated installation

@StevenDufresne StevenDufresne added the [Status] To do Issue marked as Todo label Feb 22, 2024
Copy link

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

@StevenDufresne StevenDufresne changed the title Installation sections doesn't contain relevant installation information. Installation section doesn't contain relevant installation information. Feb 22, 2024
@squelchdesign
Copy link

Just my tuppence worth, but could some of those 30% of bounces be people actually looking to download WordPress? Some might also be looking for the hosting requirements page. I'm not understanding why Optimization and SEO is in the installation section either.

@estelaris
Copy link
Member

We are not adding links to any developer handbooks on documentation. The goal of documentation is to provide information, how to's and guides for non-developers, adding links to developers documentation defeats the purpose.

Developers can easily find the information in the developers documentation, which has been reviewed or is being reviewed by developers and recategorized with a dev-point of view.

@flexseth
Copy link
Collaborator

flexseth commented Apr 8, 2024

Back in the day there was the "Famous Five Minute" install. Quite possibly the first documentation page for WordPress I ever saw... It was one of the pages I remember going back to over and over again when starting to use WordPress in a larger capacity. From there you could get to the info on permalinks, which linked to Apache settings.

While I understand it is end-user documentation, what if someone winds up on the documentation page and wants to install WordPress. They end up bouncing and going to a search engine - "how to install wordpress"- find 5 sponsored results from web hosts show up. This could be a limitation to them wanting to do more with WordPress, over time.

As I understand it is important for the Foundation to keep a close relationship with web hosts as they sponsor the project. But also there are people who want to dive deeper and be more hands-on with WordPress. So let's support them too.


Guess the distinction to be made is someone who wants to say

I installed WordPress myself!

and a lot of new users who will have a web host, or do the one-click installation through a web host.


I agree with @StevenDufresne that it would be good to provide a link to the installation docs.

Looking over documentation pages since they have been migrated, it seems like a lot of content was lost.


possible solution?

What about providing a simple link at the bottom of the page:

If you would like to install WordPress yourself, please visit Advanced Administration.


caveat

The Advanced Administrative page needs work too

Just thinking about supporting someone who may want to be more than a WordPress "end-user" :)

@flexseth flexseth self-assigned this Apr 8, 2024
@github-actions github-actions bot added [Status] In progress Issue is in progress and removed [Status] To do Issue marked as Todo labels Apr 8, 2024
@flexseth
Copy link
Collaborator

flexseth commented Apr 8, 2024

Scrolled up and accidentally assigned the issue to myself...

Can we have a discussion about the experience, @estelaris?

@StevenDufresne
Copy link
Author

We are not adding links to any developer handbooks on documentation. The goal of documentation is to provide information, how to's and guides for non-developers, adding links to developers documentation defeats the purpose.

@estelaris I understand this from a philosophical point of view, but we aren't practicing what we preach. The "optimization" link, the second one in the list, redirects to the developer docs optimization page. How does this differ?

Ultimately none of these articles are relevant to "Installation" and we should either remove the section altogether or provide access to information that relates to its stated objective. I'm having a hard time understanding who this section is serving in its current state and what is justifying keeping it around. The only thing I can see in the data is that people are looking for help installing and being underserved.

possible solution?
What about providing a simple link at the bottom of the page:
If you would like to install WordPress yourself, please visit Advanced Administration.

I would prefer to add it as a first link and monitor anonymous pageview data. I am sensitive to the blurred lines between the docs and the developer docs and would also like to see clearer lines between the two, and if we think doing so causes more problems than it solves, I'm fine with a callout lower down the page for now.

The Advanced Administrative page needs work too

Agreed. (WordPress/Advanced-administration-handbook#325)

Just my tuppence worth, but could some of those 30% of bounces be people actually looking to download WordPress?

@squelchdesign It's a possibility. The download page also includes a link to the installation guide so we could also try this as well.

@estelaris
Copy link
Member

I still don't think that we should add any links to the developer handbooks. These are the solutions I can offer:

  1. rename the articles that should be in HelpHub
  2. revise the category description to something like: "Items to be aware before you install WordPress" (this content is under review)
  3. remove the articles that have been redirected to the Advanced Admin handbook
  4. Add a subtitle or intro paragraph to highlight that HelpHub is "documentation for non-devs"

@estelaris estelaris assigned estelaris and unassigned flexseth Apr 9, 2024
@estelaris
Copy link
Member

@flexseth your comment is all about developers. You are not thinking about non-developers. That 5-minute installation was a nightmare to a non-dev and the best that ever happened was the on-click hosting installation.

Developers have numerous resources to figure things out and feel proud of the work they do. Let's leave this section to non-devs only

@squelchdesign
Copy link

I agree that we shouldn't assume everyone coming to that page is a developer, but what's the harm in beginning with the easy options for non-developers with further reading at the bottom for the more technically minded? These are the technical guides after all.

@flexseth
Copy link
Collaborator

flexseth commented Apr 9, 2024

@flexseth your comment is all about developers. You are not thinking about non-developers. That 5-minute installation was a nightmare to a non-dev and the best that ever happened was the on-click hosting installation.

Developers have numerous resources to figure things out and feel proud of the work they do. Let's leave this section to non-devs only

I think the confusion comes (for me) - in that the docs look the same. I didn't look at that as an "end-user" docs page... as I got involved with the documentation process after the new systems were put in place.

Guess I never really used the "end-user" docs before so maybe that is also a consideration. I'm not looking to discount end-users, but there may be a subset of end-users who want to eventually do more with WordPress.

So I'm just wondering from a UX perspective, how to see the journey the user takes, over time, to become a more "advanced" user than just an "end-user." I don't know that everyone wants to be a developer, but plenty of people want to better administer their website. That's the overlap / user persona I'm thinking about! :)

@flexseth
Copy link
Collaborator

flexseth commented Apr 9, 2024

Other documentation articles provide waypoints to direct users to the correct place
image

https://wordpress.org/documentation/article/where-to-find-wordpress-help/

@StevenDufresne
Copy link
Author

revise the category description to something like: "Items to be aware before you install WordPress" (this content is under review)

I would love to participate in these discussions. What would be the best way for me to get involved?

So I'm just wondering from a UX perspective, how to see the journey the user takes, over time, to become a more "advanced" user than just an "end-user." I don't know that everyone wants to be a developer, but plenty of people want to better administer their website. That's the overlap / user persona I'm thinking about! :)

I agree and many people who administer their website (which includes installing) don't consider themselves developers. The idea that "installing" is strictly a developer task feels like an unproven assumption. For me developing means building and installing doesn't neatly fall within that category.

I appreciate the thoughtful debate. I do think this page allows us to test a few assumptions in a low-risk environment so let's link to the installation docs and the download page and see what a month of anonymous data suggests. If it doesn't have a meaningful impact we can pull it out. I'll look at our current patterns for inspiration and put up a draft here.

@flexseth
Copy link
Collaborator

Found a callout when I landed somewhere in support land... maybe a callout to link to more "advanced usage" examples?
Screenshot 2024-04-09 at 1 04 21 PM

@StevenDufresne
Copy link
Author

Thanks @flexseth I saw that above. I feel it is probably too aggressive of a visual for this experiment. It seems to me like it will overshadow the other links and lead to skewed results...?

@flexseth
Copy link
Collaborator

I feel it is probably too aggressive of a visual for this experiment.

Totally agree, just a sentence with a link to the "self-hosted" install instructions would probably do. I was just pointing out that other docs cross-link to provide guidance where to go :)

@pooja9712
Copy link

Hii there, I want to do it could you please assign it to me??

@StevenDufresne
Copy link
Author

HI @pooja9712! Thanks for volunteering. I didn't get a chance to cycle back to this with an example yet. I agree with @flexseth that we can probably add a sentence below the content for now.

I'm thinking something like this:

Example
Screenshot 2024-04-16 at 9 56 04 AM

I'm not sure where this will need to be added, but if it can't be added via documentation files, I can help with any code changes that we may need.

Thanks!

@estelaris
Copy link
Member

There are too many issues already on this ticket and we cannot work like this. I am going to review and close the ticket after I assigned each topic a new ticket. Please continue the conversations in the right ticket.

@github-actions github-actions bot added [Status] Done Issue is completed and removed [Status] In progress Issue is in progress labels Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Status] Done Issue is completed
Projects
Status: Rejected
Development

No branches or pull requests

5 participants