使用技巧

WordPress贡献者寻求改善古腾堡开发人员文档的赞助

WordPress贡献者寻求赞助以改善Gutenberg开发人员文档WordPress贡献者寻求赞助以改善Gutenberg开发人员文档

WordPress开发人员 米兰娜帽乔纳森·波森格 正在启动一项筹款活动,以改善古腾堡开发人员的文档。 对话于昨天开始,当时Cap在推特上发布了有关公司聘请专职人员从事WordPress工作时经常被忽略的文档的推文。

Cap说:“当社区无法学习您的软件时,您就没有贡献者了。” “文档和教程对开源软件项目的重要性远远超过人们的认识。”

Cap第一次开始索要Gutenberg文档是在2017年巴黎的社区峰会上。从那时起,她一直在努力吸引社区的注意。

Cap说:“对于开发人员来说,块编辑器文档中有很多漏洞,但最明显的是如何开始。” “的开始 开发人员文档 什么也没说。 “它只说您可以用一个块做什么,而不能说_how_。 初级开发人员,仅PHP开发人员以及该文档所针对的任何人都不知道块的代码外观,放置位置,如何包含块等,更不用说如何使用自定义组件构建自定义块了,设置。”

文档化块编辑器的部分挑战在于它正在积极开发中。 不断地对Gutenberg插件进行增强和改进,跟踪内核中当前可用或不可用的内容并不总是那么容易。 由于WordPress迫在眉睫 介绍块目录搜索,这是正式建立块创建文档的好时机。

Cap说:“整个文档都缺少代码示例,”。 “存在最基本的示例,但是缺少如何实际构建可用的东西。 因此,在第一页上,我们被发送到一个教程,但是该教程并未针对从未构建过块的人进行优化。 紧随其后,我已经并且将无法建立该区块。”

Marcus Kazmierczak和一组文档提供者正在尝试重建官方块编辑器手册中的教程。 一个GitHub 问题 专注于解决当前开发人员文档中的空白的地方是关于为阻止开发的新手重写文档的最佳方法的积极讨论的所在地。

卡普说:“这是一个很好的开始,但仍有很多工作要做。” “完整的文档是由了解和理解React和Gutenberg但被知识所吸引的人编写的。” 他们没有太多时间花在了解别人不知道的多少以及应该写哪些详细文档上。 老实说,我认为他们不应该花时间在那上面。 我们有一个文档团队,我们愿意加入,但是某种桥梁是必要的。”

古腾堡开发人员文档的问题:对新来者不友好

“在块编辑器文档中,我看到的’问题’是,与其他WordPress文档不同,它是为有经验的JavaScript开发人员编写的,而不是针对初学者的,” Bossenger说。 “我还应该指出,这绝不是对将当前文档整理在一起的人们的一个镜头,并且我感谢他们到目前为止所做的所有工作,这非常需要审查和完善。 ”

Bossenger表示,过去,WordPress使拥有有限PHP知识的任何人都可以使用动作和过滤器挂钩快速构建插件或主题。 查看代码并理解应该执行的操作很容易。

Bossenger说:“现代JavaScript,特别是React,是一种截然不同的鱼。” “它需要对React如何工作有更深入的了解,包括新的术语和实践。 现代JavaScript也可能非常令人困惑,尤其是在这是您第一次看到箭头功能或不太冗长的if语句时。

“如果您最接近在WordPress中使用JavaScript的人一直在使用jQuery,那么切换到基于React的Gutenberg开发仍然需要您一些学习。”

Bossenger在参加了两门课程之后,才能为编辑器建立任何东西,一门在React上,一门在Gutenberg上。Bossenger说,当前的Block Editor手册不是为没有React和现代JavaScript经验的开发人员编写的。 他认为,需要对其进行重组,以更好地解释新概念并适应新手更容易使用的模式。 他强调了 插件开发人员手册 例如,各章遵循一种结构并使用更像是一本教科书的术语,从而向读者慢慢介绍新概念。

Bossenger说:“我认为,如果没有任何插件或PHP知识的人,只要拥有本手册和Google,就有可能很快构建一个简单的插件来满足他们的特定要求。” “目前,块编辑器手册不利于此。”

Bossenger对当前文档并不孤单。 Delicious Brains的Peter Tasker最近发布了有关 创建一个自定义的古腾堡块。 即使在过去的一年中全职工作于React,他仍然发现官方的块编辑器文档“种类繁多”且难以解析。

在Cap谈到缺乏公司全职从事文档工作的评论之后,Bossenger用一条推文测试了这片水域,询问这两家公司是否有能力筹集资金来改善Gutenberg文档。

卡普说:“与团队编辑团队(和任何其他Make团队一样),文档团队人员不足。” “我们负担不起几个成员先学习然后编写有关使用块编辑器进行开发的文档的负担。 这是我发推文的主要原因。 您会看到所有赞助者都来自核心,但没有文档,我敢说两者同等重要。”

在启动筹款活动之前,Cap and Bossenger计划仔细阅读现有文档,找出明显的漏洞,并找出对于块编辑器开发新手来说仍未解决的问题。

她说:“一旦有了计划,我们就可以预测每个零件需要多少时间。” “有了这项计划,我们将寻找赞助商。 我认为甚至可以在此之前进行捐赠,但是目前还不确定。”

区块是WordPress开发的新领域。 为初学者投资可靠的文档和教程可能会对扩展区块链生态系统产生重大影响。 这也间接给用户带来了好处,因为在定制他们的WordPress网站时,他们最终获得了更加多样化的块目录以供选择。

Bossenger和Cap目前正在为文档制定计划,然后再宣布其筹款活动。 同时,任何想为改进区块创建文档做出贡献的人都可以加入GitHub 讨论区

像这样:

喜欢加载中……

资源