报告问题

文档团队负责几个不同的项目。这些项目使用不同的工具进行贡献,因此,根据项目的不同,报告问题具有不同的工作流。

此页面主要针对一次性和首次贡献者。因此,如果您刚刚开始为文档团队做出贡献,或者您只是想报告遇到的问题,那么本页应该提供一个简单易行的分步指南,介绍如何做到这一点。

报告任何类型的文档问题的最简单方法是访问#文档 松弛(Slack)松弛(Slack) Slack是一个协作群聊平台https://slack.com/WordPress社区在https://make.wordpress.org/chat/.频道和发布。如果你知道文档项目这个问题在吗,你甚至可以发出砰的声响发出砰的声响 向端点发送少量数据的行为。Ping在计算机科学中用于非法获取目标服务器的响应以测试其连接。Ping也是Slack用户向@someone或向他们发送直接消息(DM)时使用的术语。用户可能会说一些类似“会议开始时给我打电话”的话负责人。查看我们的所有代表团队页面.

帮助中心

HelpHub是终端用户文档的工作标题,位于https://wordpress.org/support网站/。如果你在那里的一篇文章中发现了问题,下面是如何报告的方法。

顶部

内容问题

您发现了输入错误、过时或不正确的信息或屏幕截图、断开的链接或图像,或任何与内容相关的问题。 

注意:我们计划利用直接在发现问题的文章上报告问题的独特经验,增强HelpHub内容问题工作流的报告功能。在应用之前,我们有两个单独的工作流。 

块是一个抽象术语,用于描述使用WordPress编辑器组合在一起形成网页内容或布局的标记单元。这个想法结合了过去可能通过短代码、自定义HTML实现的概念,并将发现嵌入到单一一致的API和用户体验中。编辑内容由维护阿基拉·塔奇巴纳

报告现有内容的问题:

  • githubgithub GitHub是一个提供git存储库在线实现的网站,其他开发人员可以轻松共享、复制和修改这些存储库。公共存储库可以免费托管,私有存储库需要付费订阅。GitHub引入了“拉请求”的概念,在将贡献者在分支中所做的代码更改合并为存储库所有者之前,可以对其进行审查和讨论。https://github.com/回购并检查现有问题,如果有人已经开始讨论-https://github.com/WordPress/HelpHub/issues网站
  • 如果没有,打开新问题:
    • 受让人:阿塔奇巴纳
    • 标签:错误

请求新内容:

任何块编辑器相关内容由维护比吉特·保利·哈克

报告块编辑器最终用户文档问题:

顶部

发展问题

在呈现内容时,您发现一篇文章的布局损坏或有任何类似的意外行为。

HelpHub开发由以下人员维护Milana帽子.

报告开发问题:

  • 元是指组内部工作的术语。对我们来说,这是一个在WordCamp Central和Make WordPress等内部WordPres网站上工作的团队。 Trac公司Trac公司 Trac是贡献者为bug或功能请求创建问题的地方,与GitHub非常相似。https://core.trac.wordpress.org/.并检查现有HelpHub票据中是否有人已经报告了该问题–https://meta.trac.wordpress.org/query?状态=!closed组件=HelpHub(&C)
  • 如果没有,请选择“新票据”
  • 从下拉列表中选择“HelpHub”组件
  • 确保“Summary”字段对问题进行了总结
  • 在“描述”字段中,尽可能详细地描述问题(欢迎使用链接和屏幕截图)。如果可能,描述应遵循模板:
    • 预期行为
    • 实际行为

请求功能:

  • 如果有人已经开始讨论,请转到GitHub回购并检查现有问题–https://github.com/WordPress/HelpHub/issues网站
  • 如果没有,请选择“新问题”
    • 受让人:zzap
    • 标签:增强
  • 确保“标题”字段总结了功能
  • 在“Description”(描述)字段中,尽可能详细地描述功能(欢迎使用链接和屏幕截图)。如果可能,描述应遵循模板:
    • 功能的描述
    • 此功能如何增强文档和用户体验?

顶部

开发中心

DevHub是所有开发人员文档的工作标题,一组手册位于https://developer.wordpress.org/并非所有项目(手册)都由Docsumentation团队负责。REST APIREST API REST API是RESTful Application Program Interface(API)的缩写,它使用HTTP请求获取、输出、POST和删除数据。这是应用程序前端(想想“手机应用程序”或“网站”)如何与数据存储进行通信(想想“数据库”或“文件系统”)https://developer.wordpress.org/rest-api/.,WP-Cli公司WP-CLI公司 WP-CLI是WordPress的命令行界面,用于以编程方式执行管理和开发任务。项目页面是http://wp-cli.org/ https://make.wordpress.org/cli/WordPress编码标准WordPress编码标准 WordPress中发布的辅助功能、PHP、JavaScript、CSS、HTML等编码标准编码标准手册.也可以指PHP_CodeSniffer规则集合(嗅探)用于格式化和验证根据PHP编码标准为WordPress开发的PHP代码。手册由各自的团队维护。 

主题手册是文档和主题审查团队的共同责任。其他一切:代码引用、块编辑器、通用API和插件都由文档团队维护。 

顶部

代码参考

代码参考分为三部分:

顶部

内联文档

由于创建的性质,内联文档由核心核心 Core是运行WordPress所需的一组软件。核心开发团队构建WordPress。团队现在有一段时间了,但它仍然是文档。在中阅读有关内联文档的更多信息核心团队手册.

报告问题:

顶部

更多信息

此部分显示在“相关”和“用户贡献的笔记”部分之间。其目的是进一步解释代码及其用法。它不适用于代码示例。这就是用户注释的目的。

更多信息部分由维护朱利奥·波蒂尔.

目前,报告该问题的唯一方法是将其发布在#文档松弛通道。

顶部

用户注释

用户注释是有关如何使用函数、类、方法或挂钩的代码片段和示例。它们的工作方式与注释完全相同。 

像发表评论一样发布示例。在文档团队审核之前,它将被适度保存。为了适当菲律宾比索菲律宾比索 PHP(PHP:Hypertext Preprocessor的递归缩写)是一种广泛使用的开源通用脚本语言,特别适合web开发,可以嵌入到HTML中。http://php.net/manual/en/intro-whatis.php.语法高亮显示使用短代码短代码 短代码是WordPress文章、页面或小部件中使用的占位符,用于在站点的特定位置插入插件生成的表单或函数。包装代码示例:

[php][/php]

要报告任何已发布笔记的问题,请使用“向此笔记添加反馈”链接。它位于示例的正下方,作为对注释的回复。就像纸币本身一样,它也将被适度持有。 

报告问题或发布代码示例后,请耐心等待。不确定我们需要多长时间来审查它,因为它取决于当前队列,以及此时有多少Docs团队成员可以处理它。欢迎您加入团队并帮助处理用户注释。

用户注释由维护Jb Audras公司利奥·杰马尼.

顶部

块编辑器开发人员手册

用于在顶部或使用块编辑器进行开发的文档github从那里解析到我们的块编辑器手册.

有关对块编辑器文档的贡献,请参阅这个文档.

使用块编辑器文档报告问题:

使用块编辑器进行开发的文档由以下人员维护保罗·巴思梅尔.

顶部

通用API手册

手册通用API由维护利奥·杰马尼。本手册中发现的报告问题在#文档松弛通道。

顶部

插件开发人员手册

手册开发插件由维护MikeD。本手册中发现的报告问题在#文档松弛通道。

顶部

主题开发者手册

制定主题的手册由文档和主题审查团队共同负责。虽然我们很乐意解决本手册中发现的任何问题,但我们建议向其代表报告问题,安娜·阿尔菲里来自主题审查团队,直接进入#他们的观点松弛通道。 

顶部

文档团队手册

本手册由阿基拉·塔奇巴纳Milana帽子。如果您在此处发现任何问题,请报告#文档松弛通道。

上次更新时间: