Bug #81290 [NEW]: Documentation pages: Confusing and unclear "Submit a Pull Request" link
| From: | chealer at gmail dot com | Date: | Sun, 25 Jul 2021 13:37:02 +0000 |
| Subject: | Bug #81290 [NEW]: Documentation pages: Confusing and unclear "Submit a Pull Request" link | ||
| Groups: | php.webmaster | ||
| Request: | Send a blank email to php-webmaster+get-29459@lists.php.net to get a copy of this message | ||
From: chealer at gmail dot com
Operating system:
PHP version: Irrelevant
Package: Website problem
Bug Type: Bug
Bug description:Documentation pages: Confusing and unclear "Submit a Pull Request" link
Description:
------------
A while ago, I reported bug #77348, about the misleading Edit button
which then linked to the not-so-famous "Php Docbook Online Editor".
I'm happy to see PHP documentation pages no longer rely on "Php Docbook
Online Editor". I'm also happy to see pages no longer have a misleading
"Edit" link which only allows to propose changes.
Unfortunately, its replacement is quite confusing, and is unclear. The
link which replaces "Edit", to the left of the "Report a Bug" link at
the top of pages like https://www.php.net/manual/en/pdo.prepare.php,
is
a link to https://github.com/php/doc-en labelled
"Submit a Pull
Request".
Presumably, a contributor would be expected to do something like the
following:
1. Create an account on the GitHub website and login
2. Create a Git branch dedicated to his proposal
3. Figure out which file needs to be modified
4. Modify the file
5. "Submit a Pull Request", a cryptic way to say the contributor must
conclude by offering his changes, which is technically a *request* for a
PHP developer with the necessary credentials to "pull" (Git jargon) the
contributor's branch and merge its changes in the repository.
This label is obviously high in jargon, but there is a reason for that:
a proper label on that same link would surely leave contributors even
more confused about what they'd need to do.
Therefore, I recommend to:
1. Link instead to a page documenting how a change may be performed or
proposed
2. Switch to a functional and vendor-neutral label (like "Propose a
change / Edit", proposed in #77348)
--
Edit bug report at https://bugs.php.net/bug.php?id=81290&edit=1
--
Fix committed: https://bugs.php.net/fix.php?id=81290&r=fixed
Fixed in release: https://bugs.php.net/fix.php?id=81290&r=alreadyfixed
Need backtrace: https://bugs.php.net/fix.php?id=81290&r=needtrace
Need Reproduce Script: https://bugs.php.net/fix.php?id=81290&r=needscript
Try newer version: https://bugs.php.net/fix.php?id=81290&r=oldversion
Not developer issue: https://bugs.php.net/fix.php?id=81290&r=support
Expected behavior: https://bugs.php.net/fix.php?id=81290&r=notwrong
Not enough info: https://bugs.php.net/fix.php?id=81290&r=notenoughinfo
Submitted twice: https://bugs.php.net/fix.php?id=81290&r=submittedtwice
register_globals: https://bugs.php.net/fix.php?id=81290&r=globals
PHP version support discontinued: https://bugs.php.net/fix.php?id=81290&r=phptooold
Daylight Savings: https://bugs.php.net/fix.php?id=81290&r=dst
IIS Stability: https://bugs.php.net/fix.php?id=81290&r=isapi
Install GNU Sed: https://bugs.php.net/fix.php?id=81290&r=gnused
Floating point limitations: https://bugs.php.net/fix.php?id=81290&r=float
No Zend Extensions: https://bugs.php.net/fix.php?id=81290&r=nozend
MySQL Configuration Error: https://bugs.php.net/fix.php?id=81290&r=mysqlcfg