[wp-meta] [Making WordPress.org] #7520: Move Handbooks to GitHub to ease ability to contribute content

Making WordPress.org noreply at wordpress.org
Wed Mar 20 22:03:53 UTC 2024


#7520: Move Handbooks to GitHub to ease ability to contribute content
-----------------------------+---------------------
 Reporter:  oglekler         |       Owner:  (none)
     Type:  feature request  |      Status:  new
 Priority:  normal           |   Milestone:
Component:  Handbooks        |  Resolution:
 Keywords:                   |
-----------------------------+---------------------

Comment (by flexseth):

 Replying to [comment:6 courane01]:
 > Can we use https://github.com/wordpress/revisions-extended within
 WordPress to allow contributors to submit the revisions for review in the
 teams that don't want handbooks in GitHub?

 This was discussed in the #meta channel meeting today. I think it can be a
 good way to update simple revisions, IE:

 [https://github.com/WordPress/Documentation-Issue-
 Tracker/issues/1488#issuecomment-2003112128 repeated words]

 [https://github.com/WordPress/Documentation-Issue-Tracker/issues/1487
 misspellings]

 These are simple fixes that can be done quickly, making closing out
 tickets a faster process.
 This helps the ticket backlog not get out of control as new features are
 added.



 == Possible solution for simple docs updates

 If it would be possible to look at the Revisions Extended plugin to make
 it a Canonical plugin, one supported by WP Contributors, this edibility
 could be improved going forward.

 For example, an additional functionality to show revisions side-by-side,
 in a more visual manner. This would allow for more easily updating
 screenshots in the various documentation pieces and updating

 == Opinions on using the Block Editor for docs updates, in general
 Going along the vein of "Doing things the WordPress way" - I think it's
 best to use the editor in WP to edit this content.

 As @dd32 mentioned:
 > Especially when WordPress is a CMS.

 == Opinions on using GitHub to update content
 I believe this sets up an additional step, that creates more tickets and
 more information spread out in an ecosystem (docs) that seems to be
 already a bit mirky. And the number of folks who will be able to
 contribute to documentation via PRs would could be not that much of a
 benefit, which really takes away the core power of GitHub.

 Managing Pull Requests to automagically pull in new code. In the Handbook
 and docs in general's case, PRs won't achieve anything automatically so
 adding in another source of truth seems to make it more confusing.

 == Notes on timeliness of docs updates
 via @tobifjellner
 > Then I, or any other of our more than 60 editors can just update the
 document.

 In my experience I've found that there are a lot of updates that take a
 long time to get updated, even though there are 60 editors. Some of these
 editors may be inactive or only sponsored for 5% of their time, which
 isn't quite enough time when the software project is moving so quickly.

 So I do agree on @oglekler's point that updating the info is a general
 need :)

-- 
Ticket URL: <https://meta.trac.wordpress.org/ticket/7520#comment:8>
Making WordPress.org <https://meta.trac.wordpress.org/>
Making WordPress.org


More information about the wp-meta mailing list