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

Permalink Structure Docs (wysiwyg) #58

Open
imgnx opened this issue Oct 25, 2021 · 5 comments
Open

Permalink Structure Docs (wysiwyg) #58

imgnx opened this issue Oct 25, 2021 · 5 comments
Labels
Content Review [Status] Review Issue in review user documentation (HelpHub) Improvements or additions to end-user documentation

Comments

@imgnx
Copy link

imgnx commented Oct 25, 2021

Issue Description

The documentation containing instructions to edit permalinks is too technical and many hosting platforms now limit SSH access. The new documentation should show users how to use the Settings > Permalink feature of WordPress@latest.

Note: SFTP is a viable option, but not for wysiwyg (non-API) users.

Linked to #30

URL of the Page with the Issue

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

Section of Page with the issue

https://wordpress.org/support/article/using-permalinks/#using-pretty-permalinks
https://wordpress.org/support/article/using-permalinks/#fixing-permalink-problems
https://wordpress.org/support/article/using-permalinks/#tips-and-tricks

Why is this a problem?

Because this is too technical for front-end wysiwyg users.

Suggested Fix

  1. Remove all documentation instructing users to edit .htaccess by hand.
  2. Leave the instructions on how to update .htaccess automatically — rename it to "Updating your Permalinks".

Correct instructions: https://wordpress.org/support/article/using-permalinks/#automatically-updating-htaccess

@imgnx
Copy link
Author

imgnx commented Oct 25, 2021

Can I be assigned to this, please?

@imgnx
Copy link
Author

imgnx commented Oct 29, 2021

I would also like to add that these docs should probably mention something about setting up 301 redirects since that can have a negative impact on a multitude of things.

@zzap zzap added the user documentation (HelpHub) Improvements or additions to end-user documentation label Nov 2, 2021
@imgnx
Copy link
Author

imgnx commented Nov 9, 2021

Bear with me because this is my first edit. 😅 ...

A lot of the content on this document should simply be moved to the development documentation — namely all of the content that contains code and/or anything instructing users to edit their .htaccess file.

The main part that needs to be added to this document goes something like this...


⚠️ Fixing SEO Problems with 301 Redirects

Whenever you change your permalink structure, any old links that still exist on the internet will be broken — including links to sites that are indexed by search engines such as Google. If you change your permalink structure, you should also create 301 redirects — allowing search engines to continue crawling your site and preventing users from getting a 404 error when clicking on a link that follows your previous permalink structure. One of the plugins in our library that support 301 Redirection with a large user/install base would cover much of your requirements.


Everything else about .htaccess can probably be removed or transferred to the Dev Docs.

@imgnx
Copy link
Author

imgnx commented Nov 9, 2021

Maybe this is a better search term? https://wordpress.org/plugins/search/seo+301+redirect/

@github-actions
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content Review [Status] Review Issue in review user documentation (HelpHub) Improvements or additions to end-user documentation
Projects
Status: 📋 Backlog
Development

No branches or pull requests

3 participants