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

Some end-user docs are too technical #30

Open
Kenshino opened this issue Sep 8, 2021 · 12 comments
Open

Some end-user docs are too technical #30

Kenshino opened this issue Sep 8, 2021 · 12 comments

Comments

@Kenshino
Copy link
Collaborator

@Kenshino Kenshino commented Sep 8, 2021


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

@Kenshino Kenshino added this to Backlog in Test Project Sep 8, 2021
@Kenshino Kenshino moved this from Backlog to Requires Refinement in Test Project Sep 15, 2021
@zzap
Copy link
Member

@zzap zzap commented Sep 21, 2021

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

Loading

@Kenshino
Copy link
Collaborator Author

@Kenshino Kenshino commented Sep 27, 2021

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

Loading

@zzap
Copy link
Member

@zzap zzap commented Sep 27, 2021

Done #42

Loading

@femkreations
Copy link
Collaborator

@femkreations femkreations commented Oct 5, 2021

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

Loading

@agnieszkaszuba
Copy link

@agnieszkaszuba agnieszkaszuba commented Oct 8, 2021

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

Loading

@hannaw93
Copy link

@hannaw93 hannaw93 commented Oct 8, 2021

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

Loading

@zzap
Copy link
Member

@zzap zzap commented Nov 2, 2021

The workflow for this one

  • you select a number of links from that issue,
  • open your own issue a paste all those links in there
  • go back to parent issue and link your own issue in the comment
  • I'll go through previous comments and strike through + link back links you selected
  • copy the part of article that needs editing into google doc and make the edits and submit for review
  • once the too technical part is edited, then review the whole article for style guide

Loading

@femkreations
Copy link
Collaborator

@femkreations femkreations commented Nov 11, 2021

Refer #70 for the URLs I am working on.

Loading

@femkreations
Copy link
Collaborator

@femkreations femkreations commented Nov 19, 2021

Working on #72 Managing Plugins URL

Loading

@femkreations
Copy link
Collaborator

@femkreations femkreations commented Nov 21, 2021

Working on #73 Updating and Upgrading WordPress instructions

Loading

@femkreations
Copy link
Collaborator

@femkreations femkreations commented Dec 7, 2021

Working on #79 Resetting Password

Loading

@femkreations
Copy link
Collaborator

@femkreations femkreations commented Dec 14, 2021

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

Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Content Review
In progress
Test Project
Requires Refinement
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants