WordPress 开发人员 Milana Hat 和 Jonathan Posenger 即将发布为 Gutenberg 开发人员改进文档的筹款活动。对话始于昨天,当时 Cap 在推特上发布了有关公司雇用全职人员在 WordPress 上工作时经常被忽视的文档。
我希望有人付钱做一份古腾堡文档。所有知道古腾堡的开发人员都在为它工作,没有人有时间记录它。
另一方面,Gutenberg 和 React 对于 WordPress PHP 开发人员来说太陌生了,以至于没有人能够学习它。 https://t.co/iFmpd24TwH
— Milana Cap (@DjevaLoperka) 2020 年 6 月 30 日
Cap 说:“当社区无法从中学习时当你创建软件时,你没有贡献者。” “文档和教程对于开源软件项目来说远比人们意识到的重要。”
Cap 于 2017 年在巴黎的社区峰会上首次开始索取 Gutenberg 文档。从那以后,她一直努力争取社会的关注。
“开发人员的块编辑器文档中有很多漏洞,但最明显的是如何开始,”Cap 说。 “最初的开发者文档什么也没说。”它只是说你可以用一个块做什么,你不能说_how_。初级开发人员、纯 PHP 开发人员以及本文档针对的任何人都不知道块的代码是什么样子、放在哪里、如何包含块等,更不用说如何构建自定义块了使用自定义组件和设置。
记录块编辑器的部分挑战在于它正在积极开发中。 Gutenberg 插件不断得到增强和改进,跟踪核心中当前可用或不可用的内容并不总是那么容易。随着 WordPress 即将引入块目录搜索,现在是正式化块创建文档的好时机。
“整个文档都缺少代码示例,”Cap 说。 “存在最基本的示例,但缺少的是如何实际构建可用的东西。因此在第一页上我们被发送到一个教程,但该教程并未针对从未构建过积木的人进行优化。之后,我有并且将无法构建区块。
Marcus Kazmierczak 和一组文档贡献者正在尝试重新创建官方区块编辑器手册中的教程。GitHub 问题专注于解决当前开发人员文档中的差距是关于阻止开发的新手。关于重写文档的最佳方式的积极讨论的主页。
“这是一个好的开始,但还有很多工作要做,”卡普说。“完整的文档是由了解和理解 React 和 Gutenberg 但被这些知识吸引的人编写的。老实说,我认为他们不应该花时间在这上面。我们有一个文档团队,我们很想加入,但需要某种桥梁。”
Gutenberg 开发者文档的问题:对新人不友好
“在“块编辑器文档,我看到的‘问题’是,与其他 WordPress 文档不同,它是为有经验的 JavaScript 开发人员而不是初学者编写的,”Bossenger 说。“我还应该指出,这绝不是针对那些将当前文档放在一起,我感谢他们迄今为止所做的所有工作,这些工作非常需要审查和完善。”
过去,WordPress 让任何拥有Bossenger 说,PHP 知识有限,无法使用操作和过滤器挂钩快速构建插件或主题。查看代码并理解它应该做什么很容易。
“现代 JavaScript,尤其是 React,是一条非常不同的鱼,”Bossenger 说。“它需要更深入地了解 React 的工作原理,包括新的术语gy 和实践。现代 JavaScript 也可能非常令人困惑,特别是如果这是您第一次看到箭头函数或更简洁的 if 语句。
“如果您最接近在 WordPress 中使用 JavaScript 的人一直在使用jQuery,然后切换到基于 React 的 Gutenberg 开发仍然需要您学习一些知识。
Bossenger 在学习两门课程之前无法为编辑器构建任何东西,一门关于 React,一门关于 Gutenberg。 Bossenger 表示,当前的 Block Editor 手册不适合没有 React 的开发人员,而是由具有现代 JavaScript 经验的开发人员编写的。他认为需要对其进行重组,以更好地解释新概念并适应新手更容易理解的模式。他强调说例如,插件开发人员手册中的章节遵循结构和使用更像教科书的术语,慢慢地向读者介绍新概念。
Bossenger 说:“我认为如果没有人任何插件或者PHP知识,只要有这本手册和谷歌,就可以快速构建一个简单的插件来满足他们的特定要求。 “目前,块编辑器手册不利于此。
Bossenger 并不是唯一拥有当前文档的人。Delicious Brains 的 Peter Tasker 最近发布了有关创建自定义 Gutenberg 块的帖子。即使在全职工作之后React 在过去的一年里,他仍然发现官方的块编辑器文档“五花八门”并且难以解析。
在 Cap 评论说缺乏全职从事文档工作的公司之后,Bossenger 试水了一条推文询问两家公司是否能够筹集资金来改进古腾堡文档。
卡普说:“与团队编辑团队(与任何其他 Make 团队一样),文档团队人手不足。 “我们不能让少数成员先学习,然后编写有关使用块编辑器进行开发的文档。”这是我发微博的主要原因。你会看到所有赞助商都来自核心,但没有文件,我想说两者同样重要。 ”
在启动筹款活动之前,Cap 和 Bossenger 计划仔细阅读现有文档,找出明显的漏洞,并确定仍然对新的块编辑器开发人员开放的问题。
“一旦我们有一个计划,我们可以预测每个部分需要多长时间,”她说。 “有了这个计划,我们将寻找赞助商。我认为在那之前甚至可以捐款,但我还不确定。”
块是 WordPress 开发的新前沿。投资于面向初学者的可靠文档和教程可以对扩展区块链生态系统产生重大影响。这也间接地使用户受益,因为他们最终在自定义 WordPress 网站时可以选择更多样化的块目录。
Bossenger和 Cap 目前正在制定文档计划,然后再宣布他们的筹款活动。与此同时,任何愿意为改进区块创建文档做出贡献的人都可以加入 GitHub 讨论。
像这样
strong>
爱加载中...
资源