加入文档团队

以下是一些您需要的快速信息,以便开始为文档团队做出贡献。

账户:

地点:

  • 博客–用于会议议程和总结(以及与文档团队相关的任何内容)。
  • 松弛频道#文档–会议地点(以及关于团队本身的所有沟通)。
  • GitHub存储库–报告、讨论和处理所有文档的问题。
  • 手册–如何为文档团队做出贡献(有点过时)。
  • 风格指南–了解如何编写WordPress文档。

会议(每周交替)周二凌晨两点UTC:

  • 定期召开会议,议程发布在我们的博客上。
  • 我们讨论的问题分类问题来自githubgithub GitHub是一个提供git存储库在线实现的网站,其他开发人员可以轻松共享、复制和修改这些存储库。公共存储库可以免费托管,私有存储库需要付费订阅。GitHub引入了“拉请求”的概念,在将贡献者在分支中所做的代码更改合并为存储库所有者之前,可以对其进行审查和讨论。https://github.com/存储库。

现场入职培训

我们为每个有兴趣开始文档团队的人录制了入职培训。我们知道我们的“入门”文档已经过时,参与其中可能会让人感到困惑和沮丧,所以我们希望通过这些会议来简化这个过程。

概述

记录:https://wordpress.tv/2022/06/21/milana-cap-overview-onboarding-for-wordpress-documentation-team/

最终用户文档

开发人员文档

开发人员文档–插件插件 插件是一个包含一组功能的软件,可以添加到WordPress网站。他们可以扩展功能或为WordPress网站添加新功能。WordPress插件是用PHP编程语言编写的,并与WordPres无缝集成。这些可以在WordPress.org插件目录中免费https://wordpress.org/插件/或者可以是第三方基于成本的插件手册

开发人员文档–通用API手册

开发人员文档–代码参考手册

开发人员文档– 块是一个抽象术语,用于描述使用WordPress编辑器组合在一起形成网页内容或布局的标记单元。这个想法结合了过去可能通过短代码、自定义HTML实现的概念,并将发现嵌入到单一一致的API和用户体验中。编辑手册

开发人员文档–主题手册

贡献者文档–文档团队手册

Github相关角色

如果您有任何问题或想进行“更详细”的讨论,请在下面留言。

在线每月文档团队贡献者日2023年5月23日

文档团队持有在线,每月贡献者日每个月的第四个星期二。任何希望为团队做出贡献并遵循行为准则.

下一个文档团队贡献者日贡献者日 贡献者日是独立的日子,通常在WordCamps之前或之后举行,但也可以随时举行。这些活动是人们聚集在一起,在不同领域开展工作的活动https://make.wordpress.org/人们可以参与许多团队,每个团队都有不同的重点。https://2017.us.wordcamp.org/contriborday网站/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contribortorday/.

下一个每月的在线文档团队贡献者日将是:

什么时候?:2023年5月23日星期二下午1:00-4:00 UTC

在哪里?:#文档频道打开松弛(Slack)、和上的缩放.

另请参阅贡献者日——2023年5月23日githubgithub GitHub是一个提供git存储库在线实现的网站,其他开发人员可以轻松共享、复制和修改这些存储库。公共存储库可以免费托管,私有存储库需要付费订阅。GitHub引入了“拉请求”的概念,在将贡献者在分支中所做的代码更改合并为存储库所有者之前,可以对其进行审查和讨论。https://github.com/了解入职和其他重要细节。

Zoom入门

除了GitHub杂志本贡献者日的详细信息外,需要加入的人还可以询问松弛(Slack)松弛(Slack) Slack是一个协作群聊平台https://slack.com/WordPress社区在https://make.wordpress.org/chat/.或在Zoom通话中。在Zoom中,将启动一个分组室,供参与者登录。

如果您在任何时候有任何问题,请随时在#Slack上的docs频道或在中缩放一整天。

贡献者日之后

除了和一些人一起庆祝🍪🍪🍪 贡献者日结束后,也请对相应GitHub问题的评论具有:

  1. 您的WordPress.org网站WordPress.org网站 用户创建和共享WordPress代码的社区站点。您可以在这里下载WordPress核心、插件和主题的源代码,以及社区对话和组织的中心位置。https://wordpress.org/配置文件用户名
  2. 您所做的工作,并尽可能包含链接。

或者,只需评论任何内容(例如您的WordPress.org用户名),让团队知道您参加了。

#贡献者时代的,#文档

2023年5月16日文档团队会议摘要

出勤

@尼尼亚内普斯 @莱昂努格拉哈 @女性化 @第九编码器 @阿塔奇巴纳 @埃斯特拉里斯 @维沙尔穆卡达姆 @乔明尼 @萨加尔库纳尼 @绿色阴影 @查0107 @齐拉达姆 @自我 @贾维埃卡萨雷斯

家务

找到完整的成绩单会议日期:松弛(Slack).

下一个文档团队贡献者日贡献者日 贡献者日是独立的日子,通常在WordCamps之前或之后举行,但也可以随时举行。这些活动是人们聚集在一起,在不同领域开展工作的活动https://make.wordpress.org/人们可以参与许多团队,每个团队都有不同的重点。https://2017.us.wordcamp.org/contriborday网站/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contribortorday/.

下一次会议日程安排将专用于在线文档团队贡献者日,具体如下:

什么时候?:2023年5月23日星期二下午1:00-4:00 UTC

在哪里?:#文档频道打开松弛(Slack)、和“缩放”。

即将召开的会议

2023年5月30日将是5月的第五周,根据文件团队月度会议结构,将用于补充分诊会议。然而,随着WCEU的到来,团队决定将其用于WCEU准备工作

此外,以下2023年6月6日的会议被取消,因为大多数团队将前往希腊参加WCEU。

项目检查

@莱昂努格拉哈已审查并关闭#685并为创建了草稿#269

@查0107检验过的#462

@女性化创建新页面并添加内容,已审阅并关闭#238,并着手审查#487

@埃斯特拉里斯组织了两个Docs工作组,与Polyglots和特征通知团队会面

统一资源定位地址统一资源定位地址 互联网上网站或网页的特定网址,例如网站的URL www.wordpress.org文档中的更改

@埃斯特拉里斯提到贡献者不应更改任何URL。如果文章标题和URL不同,请打开githubgithub GitHub是一个提供git存储库在线实现的网站,其他开发人员可以轻松共享、复制和修改这些存储库。公共存储库可以免费托管,私有存储库需要付费订阅。GitHub引入了“拉请求”的概念,在将贡献者在分支中所做的代码更改合并为存储库所有者之前,可以对其进行审查和讨论。https://github.com/问题,团队将对其进行审查。重定向和与其他团队的断开链接存在许多问题,因此我们需要确保我们的工作不会影响其他团队

开放式地板

@绿色阴影提到WordPress Playground项目需要一本专门的手册。这方面的讨论已经在进行中GitHub问题。操场手册将在后台使用Markdown标记语言制作,类似于高级管理手册.@贾维埃卡萨雷斯将有助于创建手册。

@乔明尼提出了一个更新“制作文档”欢迎框内容。由于当前的大小,它下面用于登录的重要内容被隐藏起来。#文档,#会议,#摘要

X-post:WordPress贡献者导师计划:试点计划提案

来自的X注释+make.wordpress.org/project公司:评论WordPress贡献者导师计划:试点计划提案

2023年5月16日Docs团队双周会议议程

下次会议安排如下:

什么时候?2023年5月16日星期二,02:00 PM UTC

在哪里?#文档频道打开松弛(Slack)

议程:

  1. 出勤
  2. 为下次会议选择笔记制作人和主持人
  3. 下一次分诊会议主持人选择
  4. 项目检查
  5. 统一资源定位地址统一资源定位地址 互联网上网站或网页的特定网址,例如网站的URL www.wordpress.org变化
  6. 开放式地板

如果您有什么想在开放式地板上讨论的,请在下面留言。

#议程,#会议

2023年5月2日文档团队会议摘要

出勤

@尼尼亚内普斯 @米兰_卡普 @希拉里24 @chaion07号 @女性化 @连续介质 @medesigngood公司 @莱昂努格拉哈 @卡夫列格 @索纳利塔卡 @第九编码器 @埃斯特拉里斯

家务

找到完整的成绩单会议日期:松弛(Slack).

项目检查

@米兰_卡普关闭7个问题.

@女性化完整的问题485.

@莱昂努格拉哈检验过的#695.

@拉拉萨蒂顿281.

文档团队提醒贡献者日贡献者日 贡献者日是独立的日子,通常在WordCamps之前或之后举行,但也可以随时举行。这些活动是人们聚集在一起,在不同领域开展工作的活动https://make.wordpress.org/人们可以参与许多团队,每个团队都有不同的重点。https://2017.us.wordcamp.org/contriborday网站/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contribortorday/.

对于所有参加最后一个文档团队贡献者日,请务必对相应的GitHub问题你那天的工作。

下一个文档团队贡献者日是2023年5月23日,从UTC下午1点到UTC下午4点。

开放式地板

@米兰_卡普被问及上一个贡献者日是否有任何反馈。

@尼尼亚内普斯建议在Zoom中设置会议室,以便有需要的贡献者可以登录。在下一次贡献者会议上,我们将询问是否有人需要加入,然后根据需要打开一个会议室。

团队决定继续为期3小时的贡献者日,在下一个贡献者日之后的一周,5月的第五个星期二将举行分类会议。

@埃斯特拉里斯写的探索文档和Rosetta站点之间的通知表也希望在评论中有贡献者的反馈。

#文档,#会议,#总结

提案:当地团队手册

注:tl;dr–当地团队,例如[es.wordpress.org网站]将能够有他们的手册以补充使用全球手册,但适应当地文化的特殊性,而不是仅依赖英文版本的翻译。

目前,我们可以将手册分为三类:

所有这些文档都是英文的,由WordPress社区的一些成员在全球范围内维护。

但是,在某些情况下,尤其是每个国家、地区或地区的当地团队,有一些特定的文档需求无法添加到全球手册中。最清楚的例子是翻译的上下文文档(英语和西班牙语之间的差异,或西班牙西班牙语和墨西哥西班牙语之间的区别),或当地社区的入职文档(例如,访问他们的Slack).

为此,我们还可以添加来自其他团队的文档,这些文档会影响本地元素,例如事件,从而能够共享来自某个地区的演示文稿或WordCamp信息。

三年前,西班牙WordPress版启动了一个试点项目用于安装Make/WordPress团队中使用的同一手册插件。

这项技术可以在多个站点上使用,但结果却大相径庭。最大的问题之一是谁有权访问该网站,谁可以提出改进建议或进行更改,但存在阻止或访问限制。

这就是为什么提出以下建议的原因,该建议是基于制作/托管.

主办团队有一本手册两年多以来完全由GitHub管理这使得WordPress中的管理仅限于团队的团队代表,他们执行操作任务(订购和审查内容)。由于管理用户是WordPress.org,因此不会将内容归属于任何贡献者。

如何将内容归于贡献者?通过GitHub,因为任何在存储库中协作的人都可以对更改进行版本控制,并在他们档案的活动选项卡感谢WordPress Profile和GitHub之间的同步。WordPress文档的贡献可以游戏化。

同时,一个优点和缺点是如何在GitHub上记录它:使用标记标记语言。此语言是事实上的许多项目中使用的标准,并允许从键盘以简单的方式创建文本内容(并且很容易转换为HTML)。它也是GitHub的本地文本语言,允许直接从平台本身进行编辑,而无需安装外部程序。虽然它很容易学习,但它的缺点是您必须学习基本语法,并且您必须知道如何使用GitHub,尽管已经有人建议这是WordPress社区大规模使用的工具.

从这里开始,通过一个简单的配置,考虑到块编辑器可以本地解释标记,并且有一个工具(已经在托管团队中测试过)它每15分钟将手册存储库中任何批准的更改与WordPress站点同步一次,使世界上的任何人都可以使用标准工具为团队做出贡献,无论你是否拥有WordPres帐户。

作为起点WordPress社区西班牙语团队已经工作了一段时间一本手册,其中包含团队文件夹和社区的其他有用文件夹已创建(例如通用GitHub手册)任何人都可以为之做出贡献。

此存储库必须位于GitHub的WordPress组织下,并在该存储库和已安装在[es.WordPress.org]网站上的手册插件之间应用同步工具。

从那里,任何想要它的人都可以通过自动化系统为手册提供新内容、新想法或建议。

这应该扩展到当前区域经理一个名为本地团队代表,并遵循相同的哲学全球团队代表,成为记录当地团队代表负责出版物的审批和管理。

如今,西班牙WordPress社区的项目非常先进,能够立即启动3年前启动的本地手册自动化试点项目。


提案人@贾维埃卡萨雷斯.审核人@阿米埃罗,@阿纳瓦维兰,@埃斯特拉里斯,@甘氨酸,@米兰_卡普,@Foxtalbot先生.

+make.wordpress.org/meta品牌/

+make.wordpress.org/polyplots公司/

用可用的手册和西班牙Ping所有本地团队。

+es.wordpress.org/团队/

+af.wordpress.org/团队/

+ar.wordpress.org/团队/

+de.wordpress.org/team公司/

+en-ca.wordpress.org/team公司/

+es-mx.wordpress.org/团队/

+fr.wordpress.org/团队/

+id.wordpress.org/团队/

+it.wordpress.org/团队/

+ja.wordpress.org/团队/

+pt-ao.wordpress.org/team公司/

+br.wordpress.org/团队/

+ro.wordpress.org/团队/

+sr.wordpress.org/团队/

+yor.wordpress.org/团队/

+tw.wordpress.org/团队/

#手册,#手册

X-post:第1天:#WP20从博客到区块

来自的X注释+make.wordpress.org/营销:评论第1天:#WP20从博客到区块

X-post:探索文档和Rosetta站点之间的通知表

来自的X注释+make.wordpress.org/polyplots公司:评论探索文档和Rosetta站点之间的通知表

2023年5月2日Docs团队双周会议议程

下次会议安排如下:

什么时候?2023年5月2日星期二,02:00 PM UTC

在哪里?#文档频道打开松弛(Slack)

议程:

  1. 出勤
  2. 为下次会议选择笔记制作人和主持人
  3. 下一次分诊会议主持人选择
  4. 项目检查
  5. 提醒:注释GitHub上的贡献
  6. 开放式地板

如果您有什么想在开放式地板上讨论的,请在下面留言。

#议程,#会议

每月在线文档团队贡献者日开始于2023年4月

在双向文件团队会议中,一个季度独立领导的文档团队供款人日贡献者日 贡献者日是独立的日子,通常在WordCamps之前或之后举行,但也可以随时举行。这些活动是人们聚集在一起,在不同领域开展工作的活动https://make.wordpress.org/人们可以参与许多团队,每个团队都有不同的重点。https://2017.us.wordcamp.org/contriborday网站/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contribortorday/.被提议,很像2022年首次举办.

文档团队决定了更频繁的月度计划。

其他细节也在以下是双向文件团队会议:

  • 这些供款日将持续三个小时,
  • 他们将由任何一位想要参与的贡献者,包括团队代表、领导和其他能够提供帮助的关键贡献者,为他们提供便利,
  • 将为参与者提供Zoom链接以供他们会面#文档制作WordPress松弛(Slack)松弛(Slack) Slack是一个协作群聊平台https://slack.com/WordPress社区在https://make.wordpress.org/chat/.通道,
  • 捐款人日将被宣布,
  • 问题将在中打开githubgithub GitHub是一个提供git存储库在线实现的网站,其他开发人员可以轻松共享、复制和修改这些存储库。公共存储库可以免费托管,私有存储库需要付费订阅。GitHub引入了“拉请求”的概念,在将贡献者在分支中所做的代码更改合并为存储库所有者之前,可以对其进行审查和讨论。https://github.com/入职详细信息与第一次迭代、和
  • 出席的贡献者需要在GitHub帖子上评论他们在分配的时间内将要完成的任务,否则请注意他们正在出席。

双周会议的新月度结构

在前面提到的会议中,文档团队商定了一个新的月度结构,其中包括每月的贡献者日。

此前,团队和分诊会议每周轮换一次,因此每一次都是在Slack召开的两周一次的会议。

这两个文档团队会议的新结构如下:

  1. 第一周:Docs团队会议
  2. 第二周:分类会议
  3. 第三周:Docs团队会议
  4. 第四周:在线贡献者日
  5. 第五周:如果当月有第五周,文档团队将有额外的一周时间来弥补,或者根据需要召开分诊会议。

请注意:第五周有时被文档团队贡献者称为“暴饮暴食”的一周。它指的是团队会议和第一个在线文档团队贡献者日,在这一天,当贡献者指出问题由他们完成时,通常会给予表扬。荣誉通常以🍪 (cookie)表情符号。有时也会在贡献者日的Docs Team桌上为同人WordCamps提供饼干和其他甜点。

下一个文档团队贡献者日

第一个每月的在线文档团队贡献者日将是:

什么时候?:2023年4月25日星期二下午1:00-4:00 UTC

在哪里?:#文档频道打开松弛(Slack)、和上的缩放.

另请参阅贡献者日——2023年4月25日在GitHub上了解入职和其他重要细节。