#7520
new
feature request
Move Handbooks to GitHub to ease ability to contribute content
|
|
|
|
---|---|---|---|
|
|
|
|
|
|
|
|
|
Description
Change History (18)
#1
follow-up:
↓ 9
@
2 months ago
-
https://github.com/WordPress/hosting-handbook -
https://github.com/WordPress/plugins-handbook -
https://github.com/WordPress/test-handbook -
https://github.com/WordPress/contributor-day-handbook
-
https://github.com/WordPress/Advanced-administration-handbook -
https://github.com/WordPress/developer-plugins-handbook
-
https://github.com/WordPress/spain-handbook
#2
follow-up:
↓ 3
@
2 months ago
#3
in reply to: ↑ 2
@
2 months ago
In the Training Team, many of the contributors are not developers, and are therefor not familiar with the concept of creating PRs, or maintaining documentation in GitHub. For these reasons, updating the handbook in the Editor would seem to be “easier” for this team.
#4
@
2 months ago
This ticket was mentioned in Slack in #meta by courtneyengle. View the logs .
2 months ago
#6
follow-up:
↓ 8
@
2 months ago
#7
@
2 months ago
#8
in reply to: ↑ 6 ; follow-up:
↓ 12
@
2 months ago
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?
Possible solution for simple docs updates
Opinions on using the Block Editor for docs updates, in general
Especially when WordPress is a CMS.
Opinions on using GitHub to update content
Notes on timeliness of docs updates
Then I, or any other of our more than 60 editors can just update the document.
#9
in reply to: ↑ 1
@
2 months ago
and some "developer" handbooks
#10
@
2 months ago
#11
@
2 months ago
#12
in reply to: ↑ 8
@
2 months ago
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.
In summary, the idea is to have the texts on GitHub, pass them through GlotPress, and have them end up on WordPress sites already translated.
#13
@
2 months ago
#14
@
8 weeks ago
Possible user flow
-
User sees something to fix or improve on a documentation page -
Page Bottom: Link to "Improve this page" - meets requested criteria -
Link directs user to pertinent user flow for building documentation for this page -
User downloads blueprint for this page's documentation, instantiates Playground -
User edits docs in the block editor -
User submits the edits (new blueprint) for review (this contains the changes) -
Handbook maintainers install blueprint to view changes -
If approved, handbook maintainers can copy/paste code from block editor to update
How would this work?
Simple use cases
-
Update screenshots -
Fix spelling or grammar errors -
add paragraph spacing
Optional improvement
Benefits
-
Decouples individual content from understanding the entire handbook -
Contributor flows route content updates to relevant team -
Enforces use of the block editor, allows GitHub for collaboration -
Lowers barrier of entry to contributing to documentation teams -
No build requirements
This ticket was mentioned in Slack in #docs by zzap. View the logs .
8 weeks ago
#16
@
8 weeks ago