WordPress / Documentation-Issue-Tracker

Issue Tracker for the WordPress Documentation team.
https://make.wordpress.org/docs/
Other
84 stars 41 forks source link

Some end-user docs are too technical #30

Open Kenshino opened 3 years ago

Kenshino commented 3 years ago

Issue Description

Some end-user docs are too technical and are reflective of a by-gone era where some hosts simply failed at supporting WordPress. Hence needing us to provide documentation.

e.g. https://wordpress.org/support/article/using-permalinks/ starts talking about htaccess etc. Really, we ought to just be telling the end-user to contact their host and work it out - perhaps with a recommended text.

URL of the Page with the Issue

https://wordpress.org/support/article/using-permalinks/

Section of Page with the issue

Why is this a problem?

I believe the technical bits (not just in this link) confuses end users.

Suggested Fix

Reassess all pages with technical bits and move those to DevHub if necessary.

How to work on these articles

What is too technical? Roughly explained:

  1. no code except for wp-config.php file
  2. only what can be done in wordpress dashboard
  3. no hosting provider specific docs, no server configuration etc

What's next?

  1. Pick up an article via creating an issue
  2. If you create an issue we assume you're working on it
  3. When you're ready, via the Projects link, push it into the Content Review Column
  4. One of us will review it for "official stamping", any others can provide suggestions, it's open source
  5. Once the content is verified to be good, it needs to be pushed into the Implementation column so teh content can be transcribed to WordPress.org
  6. After implemented, the issue needs to be pushed into the Style Guide review column so that someone can apply/review if the article is following the style guide

Project board: https://github.com/WordPress/Documentation-Issue-Tracker/projects/2

zzap commented 3 years ago

I suggest we use this issue to gather all similar articles and then, by the topics covered, see where it should live. We are missing a space for some common topics, shared among all developers, such as Localisation and Internationalisation, Escaping, Sanitising.. .htaccess etc

Kenshino commented 3 years ago

Let's create a separate issue for dev docs @zzap - Can you pick that up?

zzap commented 3 years ago

Done https://github.com/WordPress/Documentation-Issue-Tracker/issues/42

femkreations commented 3 years ago

Here is the list of articles in the end-user docs that have technical content. The list is organized based on the categories. There may be overlaps as some of the articles are in multiple categories.

GETTING STARTED

INSTALLATION

BASIC USAGE

BASIC ADMINISTRATION

CUSTOMIZING

MAINTENANCE

SECURITY

TROUBLESHOOTING

ADVANCED

agnieszkaszuba commented 3 years ago

Here are some additional articles from the Getting Started category that may have too technical content:

hannaw93 commented 3 years ago

More articles from the Getting Started category that may have too technical content:

zzap commented 3 years ago

The workflow for this one

femkreations commented 3 years ago

Refer #70 for the URLs I am working on.

femkreations commented 3 years ago

Working on #72 Managing Plugins URL

femkreations commented 3 years ago

Working on #73 Updating and Upgrading WordPress instructions

femkreations commented 2 years ago

Working on #79 Resetting Password

femkreations commented 2 years ago

Working on #82 WordPress Backups, Backing Up Your Database, Restoring Your Database From Backup, Backing Up Your WordPress Files