WordPress / WordPress/Documentation-Issue-Tracker
[HelpHub] Various small issues in the Glossary doc
Open
Nobody has claimed this yet.
user documentation (HelpHub)
WP Overview
- Dominant language
- Shell
- Stars
- 109
- Forks
- 73
- PR merge metrics
- No merged PRs in 30d
Description
Issue Description
- In the introduction to the Glossary it says "If you are a contributor please don’t add definitions for generic terms (API, PHP, JavaScript, etc…).". But there are glossary entries for all these terms.
- https://wordpress.org/support/article/glossary/#bookmarklet - 'their' would be more gender-inclusive than 'his/her'.
- https://wordpress.org/support/article/glossary/#cvs - typo, "‘used to be used coordinate WordPress development." should instead be "‘used to be used to coordinate WordPress development.’.
- https://wordpress.org/support/article/glossary/#blog - this definition is maybe a bit outdated as it is more common for corporations to use blogs now
- https://wordpress.org/support/article/glossary/#moblogging - I'm not sure how many people understand this pronunciation transcription system (I don't).
- https://wordpress.org/support/article/glossary/#quicktag - I think the 'Back to the top' link shouldn't be here but at the very bottom of the page
- https://wordpress.org/support/article/glossary/#rdf would be nice if ‘RSS’ hyperlinked to the glossary entry for RSS
- https://wordpress.org/support/article/glossary/#unicode - “The most widely used collections of these character sets are the iso-8859 with iso-8859-1 and iso-8859-15 (which contains the euro sign and some characters used in Dutch, French, Czech and Slovak)“ -> I’m not sure why those languages specifically are named, it sounds a bit strange. According to the Wikipedia page, there are characters from more languages in iso-8859-15
URL of the Page with the Issue
https://wordpress.org/support/article/glossary/
Section of Page with the issue
Why is this a problem?
Suggested Fix
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the Glossary page linked in the issue and inspect the entries at #bookmarklet, #cvs, #blog, #moblogging, #quicktag, #rdf, and #unicode, along with the introduction. Review the listed wording, link, placement, pronunciation, and inclusivity concerns; done means the agreed corrections are reflected consistently in the published glossary.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100