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

Update links inside the posts-screen DOC #26

Closed
TukuToi opened this issue Aug 29, 2021 · 17 comments
Closed

Update links inside the posts-screen DOC #26

TukuToi opened this issue Aug 29, 2021 · 17 comments

Comments

@TukuToi
Copy link

@TukuToi TukuToi commented Aug 29, 2021

Issue Description

In this DOC https://wordpress.org/support/article/posts-screen/, there are several links intended to be anchor links, but they lead to other (irrelevant) pages.

URL of the Page with the Issue

https://wordpress.org/support/article/posts-screen/

Section of Page with the issue

Example:
https://wordpress.org/support/article/posts-screen/#actions > BULK EDIT

Why is this a problem?

There are links that are intended to link back to anchors on the same page.
Clicking those, however leads to pages like https://codex.wordpress.org/#Editing%20Individual%20Posts instead of the actual anchor.

Suggested Fix

Go thru the DOC, check each #anchor link and make sure it points to the correct on-page anchor.
Example in BULK EDIT Section:
selected, Bulk Action, Applied all lead to other pages.
The correct anchors would be (probably):
https://wordpress.org/support/article/posts-screen/#selection
https://wordpress.org/support/article/posts-screen/#actions
etc

@MuhammadFaizanHaidar
Copy link
Contributor

@MuhammadFaizanHaidar MuhammadFaizanHaidar commented Sep 21, 2021

@atachibana I am not able to reproduce this issue. All the anchor links are pointing to the correct on-page anchor.

anchor

Loading

@TukuToi
Copy link
Author

@TukuToi TukuToi commented Sep 21, 2021

While some of the links obviously changed and now work, not all work.
Example:

BULK EDIT

The Bulk Edit Posts ‘screen’ is displayed below the Table Of Posts header once, one, or more Posts, have been selected, and the Bulk Action of Edit is Applied. Bulk Edit allows

The Bulk Action links to a old page, so does the Applied
Screenshot 2021-09-21 at 22 09 51

Loading

@MuhammadFaizanHaidar
Copy link
Contributor

@MuhammadFaizanHaidar MuhammadFaizanHaidar commented Sep 21, 2021

@TukuToi yeah now that's a bug can you please update the section of page with issue? Thanks

Loading

@TukuToi
Copy link
Author

@TukuToi TukuToi commented Sep 21, 2021

That is since the begin the proper section.
https://wordpress.org/support/article/posts-screen/#actions
It is the only link leading to that section

The Example in BULK EDIT Section (truly a subsection of above #actions section) has no hyperlink, but it is mentioned in my suggested fix section:

Example in BULK EDIT Section:
selected, Bulk Action, Applied all lead to other pages.

Nonetheless clarified in the opening comment..

Loading

@MuhammadFaizanHaidar
Copy link
Contributor

@MuhammadFaizanHaidar MuhammadFaizanHaidar commented Sep 21, 2021

@TukuToi I have updated anchor links and some URLs that were leading to no where. Can you please counter verify. Thanks
Details of updates.

  1. Updated the anchor links for Bulk Edit section, Bulk Actions, Apply Button, Selected, Bulk Action and Applied.
  2. Updated the links for author, Edit Posts Screen, Posts Add New Screen & Post_Add_New_Screen.

anchor-updated

Loading

@TukuToi
Copy link
Author

@TukuToi TukuToi commented Sep 22, 2021

  1. Inside string so see the Bulk Edit section for details on the Bulk Editing process. holds a link that still leads to wrong section, it says Bulk Edit section but leads to #action
    In fact Bulk Edit section is not even a section, it has no link, so either we need to add a link to it, or remove that anchor
  2. Inside this This dropdown allows you to select, by date, which Posts are displayed in the Table of Posts. By default, “Show all dates” is selected and all of your Posts are displayed. it links to https://codex.wordpress.org/#Table%20of%20Posts
    Same inside This dropdown allows you to select, by Category, which Posts are displayed in the Table of Posts. By default, “Show all categories” is selected and all of your Posts are displayed.

I believe that is it, at least, it is what I see when I click on each link in that page

Loading

@MuhammadFaizanHaidar
Copy link
Contributor

@MuhammadFaizanHaidar MuhammadFaizanHaidar commented Sep 22, 2021

For part 1 : I think till we have a valid link I can remove that anchor.
For part 2 : I have updated the anchor links.

Loading

@TukuToi
Copy link
Author

@TukuToi TukuToi commented Sep 22, 2021

Looking good to me!

Loading

@MuhammadFaizanHaidar
Copy link
Contributor

@MuhammadFaizanHaidar MuhammadFaizanHaidar commented Sep 22, 2021

Thanks I added a link to Bulk Edit sub heading making it an anchor.

Loading

@jennydupuy
Copy link

@jennydupuy jennydupuy commented Sep 23, 2021

Thanks for this fix but why it is not indicated in a change log.
For teams that translate the documentation and report the changes made to the original documentation, it's hard to find where the change is located.
In the French team, we use https://developerka.org/helphub-updates/ to see which posts have been updated but often we have to scan the content to find the change made. So the changelog is valuable to find the changes.

Loading

@MuhammadFaizanHaidar
Copy link
Contributor

@MuhammadFaizanHaidar MuhammadFaizanHaidar commented Sep 24, 2021

Thanks for this fix but why it is not indicated in a change log.
For teams that translate the documentation and report the changes made to the original documentation, it's hard to find where the change is located.
In the French team, we use https://developerka.org/helphub-updates/ to see which posts have been updated but often we have to scan the content to find the change made. So the changelog is valuable to find the changes.

Hi @jennydupuy thanks for guidance my Locale is Urdu and I can't find one in the language select. Can you please guide me further how can I add these changes to the changelog. Thanks

Loading

@zzap
Copy link
Member

@zzap zzap commented Sep 25, 2021

Thanks for this fix but why it is not indicated in a change log.
For teams that translate the documentation and report the changes made to the original documentation, it's hard to find where the change is located.
In the French team, we use https://developerka.org/helphub-updates/ to see which posts have been updated but often we have to scan the content to find the change made. So the changelog is valuable to find the changes.

@jennydupuy the change was not in content just fixing destinations of links inside the article. Link was pointing on a section in the same article. It was wrong and fixed now. These changes shouldn't effect any locale really.

Loading

@zzap zzap closed this Sep 25, 2021
@zzap
Copy link
Member

@zzap zzap commented Sep 25, 2021

@MuhammadFaizanHaidar @TukuToi

Please make pull requests with your usernames added to this document: https://github.com/WordPress/Documentation-Issue-Tracker/blob/main/CONTRIBUTORS.md

Thank you

Loading

@jennydupuy
Copy link

@jennydupuy jennydupuy commented Sep 27, 2021

I agree with you @zzap, it has no impact for the locales since the link anchor will be different in each locale, but the post is mentioned as updated and the fact that there is no change log forces the locales to look for the change, thus spending time for nothing. My goal in this request is just to save time. Thanks

Loading

@TukuToi
Copy link
Author

@TukuToi TukuToi commented Sep 27, 2021

  1. There has not been any PR for this issue here AFAIK, at least, I did not create one, and I cannot see any PR linked to this Ticket neither any PR related to this ticket in the PR list
  2. If we need to keep updated some sort of list or doc we need to clarify this somewhere else than in this ticket
  3. There is no mention on point 2 above or of any PR creation process or of adding our usernames to any contributor files on the readme of this project. If any of this is required, then likely it has to be mentioned on https://github.com/WordPress/Documentation-Issue-Tracker

This ticket was a report of an error, fixed (I do not know how you do this, wether by direct edit or PR or...) by @MuhammadFaizanHaidar and thus, closed and not the place to discuss workflows IMO.

No one will find the "how to" when they are new or old to the project, if we nest and hide it inside this single, on-topic issue that now is resolved.

Loading

@zzap
Copy link
Member

@zzap zzap commented Sep 27, 2021

@TukuToi

  1. End user docs (HelpHub) is edited directly in WordPress article as we don't have GitHub repository connected to it. I have reviewed changes before closing this issue as fixed. This same procedure will apply to parts of DevHub as well.
  2. Agree. I'm open for suggestions but in new issue.
  3. Agree. I created issue for it #40

@jennydupuy as I said in No2 here, I agree. Let's discuss in new issue how we are going to handle this. What we want to avoid is having changelog longer than the content itself and above the feedback form, so maybe this is a good time to rethink what we already have for end user block editor docs (maybe even just putting changelog on second page using <!--nextpage--> tag).

Loading

@TukuToi
Copy link
Author

@TukuToi TukuToi commented Sep 27, 2021

@zzap thanks - I am then more confused as before why wed need to add some username to a list when making PRs 😃 ... if we do not make PRs... what is the point of adding the username to the list as mentioned here #26 (comment)?

EDIT:
Strike that I think I know what you mean by reading #40

Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants