Phabricator/帮助

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Phabricator/Help and the translation is 52% complete.

Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎dansk • ‎español • ‎français • ‎italiano • ‎kurdî • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎svenska • ‎русский • ‎українська • ‎العربية • ‎سنڌي • ‎پښتو • ‎हिन्दी • ‎বাংলা • ‎ଓଡ଼ିଆ • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어

致Phabricator用户,如果您有问题,可直接在讨论页询问。我们基于收到的反馈改进我们的文档。 如果您希望测试Phabricator,您应该使用实验室实例

要对Phabricator是什么,能做什么有一个基础了解,请查看幻灯片。或继续向下阅读该页面以便入门。

创建您的账户

您可以将新的Phabricator帐户与您的全域维基媒体维基帐户或维基媒体开发者帐户相关联。在这两种情况下,都不需要单独的密码。

与你的全域账户

如何通过维基媒体SUL创建您的Phabricator账户...
如何填写您的Phabricator个人资料。
  • 首先,请确保您已登录至维基媒体。
    • 如果您尚未拥有一个维基媒体账户,请注册一个。
  • 前往Phabricator登录页面(当您退出时,链接在右上角显示成进入一扇门的箭头)。
  • 点击向日葵按钮,它称为“Login or Register - MediaWiki”(登录或注册——MediaWiki)。
  • 您将需要同意MediaWiki.org连接请求。
  • Phabricator将要求您输入用户名。当您有疑惑时,直接填写您的维基媒体用户名即可,但请注意Phabricator用户名不能包含非拉丁文,例如“العَرَبِيةُ”或“中华民族”或“Xï”。亦请勿使用空格,可以用下划线“_”替代。另外需要有效的电子邮件地址以供验证,但电子邮件地址不会向其他用户显示。
  • 点击做出导航栏的Manage(管理)。
  • 点击Edit Profile(编辑个人资料)并设置您的“Also Known As”(又称,例如是您的全名)以便其他用户更容易搜索到您。

与你的维基媒体开发者账号

...或通过您的维基媒体开发者账户。
如果您有维基媒体开发者帐户,也称为LDAP帐户或Gerrit帐户或wikitech帐户,您也可以使用它来登录。相同的Phabricator用户名可以同时连接MediaWiki.org和LDAP。这可以是一个备份,万一维基媒体SUL不工作。

将您的维基媒体SUL和LDAP帐户连接到单个Phabricator用户名!否则您将创建两个单独的Phabricator帐户。

两步验证

我们不鼓励除了你访问安全任务的时候在Phabricator上使用多因素身份验证。如果您仍打算使用它,请先阅读多因素身份验证指南和要求

故障排除

  • 如果由于输入了错误的电子邮件地址而无法验证Phabricator帐户,请在Talk:Phabricator/Help上添加说明。
  • 如果您发现Phabricator帐户被禁用,请在Talk:Phabricator/Help上添加注释。
  • 当您尝试通过“登录或注册通过MediaWiki”创建Phabricator帐户时,如果您收到“已经使用的电子邮件地址”错误,您可能已经注册了与您的维基媒体开发者帐户相关联的Phabricator帐户。您必须通过您的开发者帐户登录Phabricator。如果您忘记了开发者帐户密码,请使用wikitech:Special:PasswordReset
  • To change the global wiki account or developer account that is associated to your Phabricator account:
    • Note that your Phabricator account must be associated to either a global wiki account or a developer account at all times.
    • If you want to change your global wiki account that is connected to your Phabricator account: Log into Phabricator via your developer account that is also connected to your Phabricator account. Then remove your old global wiki account and connect your new global wiki account to your Phabricator account. (If your Phabricator account is only connected to your global wiki account but not yet also to a developer account, connect a developer account to your Phabricator account first.)
    • If you want to change your developer account that is connected to your Phabricator account: Log into Phabricator via your global wiki account that is also connected to your Phabricator account. Then remove your old developer account and connect your new developer account to your Phabricator account. If your Phabricator account is only associated to your global wiki account but not yet also to a developer account, connect a developer account to your Phabricator account first.)

索要您之前在Bugzilla和RT上的账户

跟随这个链接。

接收更新和通知

订阅单个任务
监视项目以接受关于它的通知

Phabricator通知您相关活动,包括phab:settings/panel/emaildelivery/你自己的动作

Phabricator提供多种方式供您接收通知。

  • 如果您对某个单独的对象(例如一个Task、mockup等)感兴趣,点击Subscribe即可订阅该对象的通知。发表评论会自动为您订阅该对象。
  • 如果您对一个Project(项目)内的所有活动感兴趣,您可以点击该项目概要页面上的Watch Project按钮。 在Projects用户指引中有更多相关信息。

See Phabricator/Help/Managing mail for reducing the amount of mail notifications and about filtering mail notifications.

故障排除

如果您收到任务的意外邮件通知:

  • 您可能订阅了该任务。
  • 在[最亲密的任务]下的电子邮件设置中,您可能启用了“任务的子任务更改状态之一”。
  • 您可能设置了个人先驱统治。检查“X-Herald-Rules”邮件头字段以查看所有应用的Herald规则的列表。

为通知创建Herald(传令)规则

你可以关注此链接了解如何在Wikimedia Phabricator's Herald中创建自定义(个人)通知规则。这是一个更高级的选项,可能很难使用,而且由于性能原因,应谨慎使用。

创建一个任务

创建任务的方法。
如何编辑一个已创建的任务。

创建任务有多种方法,具体取决于您要携带的信息:

  • 新任务:单击顶部导航栏右侧的星形按钮。从下拉菜单中选择创建人物。你会得到一张空白表单。
  • 安全问题:单击顶部导航栏右侧的星形按钮。

从下拉菜单中,选择报告安全问题。 您将得到一个预先标记为安全的表单,并带有一个链接来提交Bug的特殊说明。

  • 现有任务的子任务:单击当前任务右栏中的编辑相关任务…→创建子任务。将设置两个任务之间的依赖关系,并且默认情况下将承载父任务的某些值(分配给、订户、优先和项目)。子任务将列在任务图下的父任务中,按最近更新的顺序排序。

填写表单,留下您不确定的字段。

Phabricator supports some formatting in text areas. See #Formatting and markup.

Use the live preview at the end of the page to check whether your text looks as you expect.

选择项目

为了将任务与使用Phabricator的项目(标签)相关联,您只需要在“标签”字段中输入其名称,然后从匹配项目列表中选择项目(该列表仅显示五个匹配项目)项目)。您可以通过单击标签字段中的放大镜图标来搜索项目并阅读简短的项目描述。您可以将一个或多个项目添加到标签字段中。如果您不确定,也可以将其留空,分类员将处理没有项目设置的任务。有一个(长)项目列表可用按编辑查询以搜索项目(此列表也可在Phabricator/Projects中找到)。

设置任务优先权

优先权(Priority)通常应由产品经理、维护人员或计划工作于对应任务的开发人员设置,或由bugwrangler或有经验的社群成员设置,而不是由提报者填写在错误报告中,或由外来人员设置。请参见Phabricator项目管理以获取详细信息。

使用电子邮件

您还可以通过向task@phabricator.wikimedia.org发送电子邮件来创建任务。主题将用作任务标题,主体将按原样直接使用,附件将包含在任务中。要设置项目,请在正文的开头添加相应的命令“!projects”及其主题标签,例如!projects #mediawiki-core可以通过电子邮件设置任务受让人,优先级或状态的其他命令。

注意:如果您的电子邮件签名没有按照事实上的标准(包括“ - ”与正文分开)进行格式化,那么它也会被发布。我们鼓励您在第一次尝试时从签名中删除私人信息,以确保这一点。

在任务创建URL中传递某些值

“报告Phabricator中的错误”链接可以通过附加到通用任务创建链接的URL参数传递大量值。

这是一个非常高级的功能。在此了解更多

Commenting and editing a task

要回复,您还需要一个帐户。

您可以在评论的同时执行多项操作。

Phabricator允许您使用文本格式和插入图像或其他文件发布和编辑注释和描述;见上传文件附件。您可以使用输入文本区域顶部的工具栏,您可以使用Phabricator的[#Uploading file attachments 使用Phabricator独有的格式]。

Use the live preview at the end of the page to check whether your text looks as you expect.

To edit the description of a task, select "Edit Task" in the side bar.

To close a task as a duplicate of another task, select "Edit Related Tasks... > Close As Duplicate" in the side bar.

Formatting and markup

如何格式化您在注释中编写的文本以及如何使用列表和标题。

Phabricator supports some formatting in text areas.

请注意Phabricator自己的标记语言与MediaWiki的标记不同

在页面的末尾,您有一个实时预览,以检查您的文本是否看起来像您期望的那样。标记的流行使用包括:

  • @username中提及用户将创建指向其个人资料的链接,并将订阅他们的任务。
  • T123中添加任务编号将创建包含悬停卡的任务链接。{T123}在文本中插入任务的标题。
  • #Project中添加项目名称将创建指向项目主页面的链接。
  • 如果您想引用文字,您只需在开头添加>。如果您想回复包含它作为报价的评论,请单击要回复的评论右端的下拉箭头。
  • 如果要在评论中显示上传的模型图像文件,例如M123,请写{M123}
  • 如果您想创建外部链接,例如在wiki标记中使用[https://www.mediawiki.org example],使用[[ https://www.mediawiki.org | example ]],包括Phabricator中的空格。
  • 如果您想在评论中添加网址(URL链接)以提供测试用例,强烈建议您从网络浏览器的地址栏复制并粘贴完整的网址,例如https://www.mediawiki.org/wiki/Project:Support_desk而不是mw:Project:Support desk。Phabricator不支持像mw:这样的Interwiki前缀,并且Bugzilla也没有的大多数自定义,例如Gerrit更改也应该粘贴为完整的Web地址。
  • 如果要粘贴代码行,请在代码前后添加一个带有三个反引号的行:```。或创建粘贴并链接到任务的粘贴。

上传文件附件

如何上传文件。

上传文件有多种方法:您可以通过鼠标拖放将文件(例如屏幕照片)添加到评论或任务说明中。用户还可以通过其系统的剪贴板功能复制和粘贴图像。

如果您的系统上没有此功能,您可以使用phabricator:file/upload并通过编写F123来查看成功上传后显示的文件编号(如“123”),在评论中。这将创建文件的“链接”。要在评论中“包含”该文件,请将ID括在大括号中:{F123}。 默认情况下,它包含在缩略图中。

有关更多格式选项,请访问[$url 语法参考手册]。

如果您必须经常上传文件并考虑当前可用的选项不舒服,您还可以添加文本面板到您的主页直接链接

请注意,您无法上传文件,然后降低文件的访问级别(例如,将其链接到受限制的安全票证)。您必须删除该文件并使用更严格的访问权限重新上传。建议上传应具有受限访问权限的文件以及创建受限(安全)票证。此外,请注意,拥有文件完整URL的任何人都可以下载文件或与他人共享链接。没有身份验证保护文件不被访问。Phabricator文件完全依赖于安全性,猜测任何给定文件的(伪随机)URL将非常困难。如果您需要为特别敏感的文件提供更多保护,那么您应该考虑更安全的替代方案。

如果您需要删除上传的文件,请打开您创作的文件的[[[phabricator:file/query/authored/|列表],选择文件并单击侧栏中的“删除文件”。

Phabricator中的项目管理

如果您维护或管理项目,请点击此链接了解更多详情。

父任务和子任务

任务可以是父任务或任何数量的其他任务的子任务。如果在解决任务B之前未解决任务A,则任务A是父任务,任务B是子任务。可以通过“编辑相关任务……”来设置这种关系。父任务和子任务显示在任务中的“任务图”下。 此功能可用于完成一些不同的事情:

  • 拦截器和子任务。(父)任务可能只是被另一个(子)任务阻塞,代表一个依赖项(参见关于如何添加子任务的Special:MyLanguage/Phabricator/Project management#Tasks that cannot be worked on yet)。
  • 跟踪。由若干(子)任务阻止的“无工作”(父)任务可能正在跟踪发布或其他时间段内的(子)任务集合。请注意,此处的“跟踪”与不推荐使用Phabricator中的#Tracking标记具有不同的含义。
  • 批准。几个(父)任务(例如草稿团队目标)可能被单个(子)任务阻止,该任务代表获得批准的草案任务,之后这些草案目标现在是真正的目标。

注意:有一个“编辑相关任务→创建子任务”功能。除了设置正确的父/子任务关系外,它还将CC(订阅)列表载入新的子任务。

优先次序

参见Phabricator/Project management#Setting task priorities

分配

参见Phabricator/Project management#Assigning tasks

追踪任务

术语“追踪人物”来自Bugzilla,它有一个特定的含义:一个任务被阻止在其他任务上,但它本身并不代表任何工作,哪个与特定的发布/日期无关。一个示例可能是名为“清理文档”的任务,该任务可能具有各种子任务,每个子任务都将描述要完成的特定工作。这些“跟踪”任务往往会持续很长时间(或永远),因为他们的子任务将得到解决,但新的任务将被创建。 在Phabricator中,项目比依赖的'跟踪任务'更受青睐

但请注意,还有其他类型的无工作伞任务在Phabricator中仍然有意义。值得注意的是发布任务。即将发布的版本可以由任务表示,该任务将子版本列为该版本的所有实际工作任务。一旦发布,它就可以解决了。 类似的用途是具有代表该季度的团队总体目标的任务,然后每个目标可能(或可能不)是阻塞子任务。

搜索项目

Search context (global vs advanced)

在上角使用Phabricator的基本搜索字段

Phabricator由几个应用程序组成(“Maniphest”中的任务管理是其中之一,或者Diffusion用于代码浏览)。

使用Maniphest的高级搜索

这里有2种不同的搜索表单:

  • The global search at https://phabricator.wikimedia.org/search/query/advanced/, confusingly labeled "advanced search." 这个很简单。 它在右上角。 By default, it searches across all applications and hence all types of documents (open tasks, closed tasks, code commits, etc…). You can change the default context using the the arrow menu to the left of the search bar. For example, select "Open Tasks" to only show results in open tasks from the Maniphest issue tracker. Or select "Current Application" to search Maniphest in Maniphest, Diffusion in Diffusion etc. Tags specified are unioned (OR'd).
  • Advanced, application specific search, for example at https://phabricator.wikimedia.org/maniphest/query/advanced/ for Maniphest. This one has more fields, and auto-completion that includes "Not in:..." (equivalent to NOT) and "In any:..." (equivalent to OR) (for example, type "echo" in the "Tags" field). There is also an advanced search for most other applications (e.g. phab:file/query/advanced for Files). To only search for tasks / bug reports, use the Maniphest advanced search. Tags specified are intersected (AND'd).

Inside Maniphest, custom, saved searches and advanced search options are listed in the navigation bar on the left.

搜索条件

Special care needs to be put in choosing correct search terms.

Some locally-valid properties for the "Query" field:

  • Case insensitive: Edit is the same as eDIt * phrase search works: "fatal error" * basic tokenization is performed, e.g. to strip punctuation * Stemming is performed: "edited" is also found when searching for edit. However, "edited" does not match edit as quoted text does not stem. * Substring search is supported: ~amp matches example, but amp does not. * ~"an examp" matches an example as quoted and substring-operator text uses substring search. * Boolean queries to exclude certain terms are possible by using the - symbol before the unwanted term. E.g. use -non fatal error to exclude "non-fatal" errors from results. * To only search in a task title but not in the task description or comments, use title:quick ferret which is the same as title:quick title:ferret. To search for one term in the task title and other terms anywhere in a task, use ferret title:quick or title:quick all:ferret. See https://secure.phabricator.com/book/phabricator/article/search/ for more information.

The advanced search forms are not explicit about the logic but in general use AND between different fields. You can exclude specific projects from the results by entering not(projectname) (equivalent to NOT) and combine several projects via any(projectname) (equivalent to OR) via the auto-completion suggestions. There's a limit of 5 items in the maniphest autocomplete. To increase this limit, see these userscripts for Chrome and for Firefox.

Alternatives ways to find something

If you don't remember the exact words used in an item you are looking for you can follow one of these paths:

  • use the activity feed and edit the query to be restricted to certain projects or timeframes
  • use the activity feed to list all actions that you performed in a certain timeframe at phab:feed/query/EW2FwdAi.Kfz/
  • use an external search engine;
  • remove all search terms, refine the search only by project etc. and then scan all the possible results manually or use Ctrl+F to search specific strings (this might require setting "Page Size" to a high value to display more than only 100 results);
  • file a new task, mentioning that a past report exists as well, and wait for someone to merge the new report to the old.

选择日期和日期范围

这仅适用于高级搜索。

Using the Date fields like "Created After" and "Created Before" allow entering absolute and relative dates. Note that Maniphest uses UTC.

To get a list of tasks which were created in the last 24 hours, set the "Created After" field to "-24 hours" or "-1 day". Note that "Updated Before" actually means "Last updated before" and that absolute date values like "2014-11-26" refer to UTC time while your time zone setting might be different. The "Updated After" and "Updated Before" fields return any and all changes to a task. For example, when a task is moved to another column in a board it registers as "updated". This may add noise to your search results.

Examples of how Maniphest interprets searches:

  • "02/25/2015" - interpreted as "00:01 on February 25th, 2015" (UTC)
  • "5 days ago" - interpreted as "00:01 on the fourth calendar day before today" (UTC)
  • "2:45 AM 5 days ago" - interpreted as "02:45 on the fourth calendar day before today" (UTC)

The "X days ago" range can be confusing. Phabricator interprets today as part of any data set. Even if it is 12:30 UTC, Phabricator will interpret that as a potential day in the range.

Saving and Managing Searches/Queries

Queries can be saved and managed inside Maniphest.

Maniphest offers links to some predefined search queries in the navigation bar on the left. For example, click authored to get a list of tasks that you have created.

Search query addresses (URL) are stable so you can save and reuse them. You can share the address in your web browser's address bar with other people, e.g. via posting the link on a wikipage.

If you want to save a search, select the "Save Query" button at the bottom of the Advanced Search UI.

When looking at the navigation bar on the left in Maniphest, click on the "Edit Queries…" link. You will see a list of your saved queries. All users have a default set which can be deleted in this UI.

Some options in this UI:

  • Use the line elements on the left to drag queries up and down in the list.
  • The "x" will permanently delete a Query.
  • The Pencil icon allows a user to edit the name of a query
  • Clicking on the name of a Query will bring up the search options and results of that query

Once you save a query, you cannot change its parameters, but you can change its name. To edit a query, click on it's name, change parameters and save it as a new query. Also, Phabricator allows users to save multiple queries with the same name.

To make the user name dynamic (e.g. for "Tasks assigned to the person running this query") in searches that you'd like to share with others, select Authors > Magnify glass icon > Browse Users > "Current viewer".

Note that some common queries are also available in the "Activity" tabs on the Phabricator frontpage.

Finding the Maniphest task corresponding to a Bugzilla bug number

This is only available in the Advanced Search.

All Phabricator tasks migrated in 2014 from Bugzilla have a Reference field that contains a value "bz" followed by the number of the equivalent report in Bugzilla. If you want to search the task corresponding to a specific Bugzilla report, use the Reference field in the advanced search or just add 2000.


高级功能

使用控制面板

仪表板是专门设计的主页,可以显示各种自定义信息。可以在用户之间创建,管理和共享它们。

单击此处查看详细的仪表板演练。

批量编辑

Phabricator提供了执行任务的批量/批量编辑的可能性。在任何Maniphest搜索查询结束时,您将找到“批量编辑选定”以使用Shift键单击编辑您选择的所有任务。愿意使用此功能的用户需要加入Triagers组。

通过注意批量编辑开始时生成的“批量作业”ID,可以反转批量编辑。可以通过在执行之前或之后单击“详细信息”来访问它。在下一页上,右侧将出现一个“继续”菜单项,它将生成所有受影响任务的Maniphest查询。

收藏夹

可以自定义顶部导航栏中的“星形”菜单,其中包含指向首选表单和操作的链接。

有关详细信息,请参阅配置文件菜单说明。

个人物品清单

“Flag For Later”功能提供了“您希望以后再看”的标记对象(如任务或修订版)。有八种旗帜颜色可供选择。标志是个人和私人的,因此您的列表不能与他人共享。标记的对象列在flag上。与tokens相比,可以按颜色或对象类型搜索它们。

创建项目

截屏显示如何申请项目

在Phabricator项目中是标签,标签是项目。通过子项目的层次结构自2016年2月起可用。[1]可以分配任务。对于多个项目,也可以在不将其分配给任何项目的情况下提交。

你什么时候需要一个项目?

一般来说,你需要一个项目......

  • 当你有一个已经建立的团队运行一个或多个项目时(从这里开始,只在你需要更多时询问更多)
  • 当你需要一个工作板(即冲刺)
  • 当您需要标记或关键字来组织可以成为任何项目一部分的任务类型时(例如“辅助功能”)

申请一个新项目

参见Phabricator/申请一个新项目

限制对任务的访问

可以通过“编辑任务”更改对特定任务的访问,然后将“可见”字段更改为“公共”以外的其他字段。

请注意,作为安全问题提交的任务不公开。 See Reporting security bugs for more information. See Phabricator/Creating and renaming projects#Project policies for default project settings (and using Spaces).

显示和使用空格

Spaces (upstream documentation) allow restricting access to groups of objects (like tasks) to members of a specific group only. See Restricting access via Space policies for setting up.

If you can access at least two spaces, you see an additional Spaces dropdown under "Visible To" when creating and editing an object. Users with access to only one space will not see this control.

In Maniphest's task view, the Space will also be displayed in front of the task summary. You can batch-edit tasks to move them to a different Space.

Note that you will still have to associate the corresponding "public" project (if existing) to a task to make a task in a restricted Space (which you have access to) to show up in search queries and the workboard of the project. The "public" project could be automatically added via requesting a global Herald rule.

When creating tasks in Spaces, use the "Create Advanced Task" option in the "Create Task" dropdown. This option will display an additional Spaces dropdown under "Visible To" in the task creation UI that will allow you to set visibility to the Space for which this task should be visible.

If you instead create a task via the "Create Simple Task" option in the "Create Task" dropdown, then after you create it, you will have to edit the task to restrict visibility to members of the Space. Before this edit, the task will be visible to anyone and notifications about your task might have been sent to public logged IRC channels and other subscribed individuals.

MediaWiki模板与链接

  • 您可以通过使用phabricator:及其简短版本phab:,从wiki页面链接至Phabricator任务,例如[[phab:T454|此示例]]会生成example
  • Template:Tracked已更新,以便包含至Phabricator对象的链接——参见右侧{{Tracked|T177|resolved}}是怎么生成的。
  • Template:Phabricator同样可用;{{Phabricator|T176}}会生成任务T176

现有Bugzilla链接和模板仍将工作,因为这些链接将继续指向bugzilla.wikimedia.org,而它将重定向至转换过的Phabricator任务。

统计

Phabricator offers tables showing the open tasks by priority and by either user or project. Apart from that, Phabricator doesn't support further statistics, metrics, charts, reports (e.g. over time) or however you may call them, whether built-in or via an API.[2] Phragile and Phlogiston are further reporting tool options for Phabricator.

Code browsing (Diffusion)

Diffusion is the Phabricator repository browser[3]. Another option is using gitiles at https://gerrit.wikimedia.org/r/plugins/gitiles/?format=HTML for repository read-only mirroring. Right now, we're mirroring some of our Git repositories to Phabricator for demonstration purposes.

To request and set up a new code repository, see Gerrit/New repositories/Requests.

默认字段(表单)

Phabricator允许对给定任务显示的字段进行一些自定义。 这些是通过Forms功能处理的。

API (Conduit)

Conduit is the name of the web API. https://phabricator.wikimedia.org/conduit/ offers some explanation and examples. See the Conduit upstream documentation. Also see Phabricator/Bots.

其他链接

  1. 子项目T3670,在上游Phabricator实例上
  2. T1562 (statistics), on the upstream Phabricator instance
  3. Diffusion repository browser user guide, on the upstream Phabricator instance