فېبرېکېټر/لارښود

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

Other languages:
বাংলা • ‎English • ‎español • ‎français • ‎日本語 • ‎Kurdî • ‎polski • ‎پښتو • ‎português • ‎русский • ‎سنڌي • ‎ไทย • ‎українська • ‎中文

Dear Phabricator user, if you have questions, just ask in the Discussion page. We improve our documentation based on the feedback received. If you want to test Phabricator, You should use the Labs instance.

For a high level understanding of Phabricator, click the link that follows. Or keep reading this page to dive right in and get started.

What is Phabricator and what does it do?

Creating your account[edit]

How to create your Phabricator account with Wikimedia SUL...
... or with your LDAP / Labs / Gerrit account.
How to fill your Phabricator profile.
  • First, make sure you are logged in to Wikimedia.
    • If you don't have a Wikimedia account yet, sign up for one.
  • Go to the Phabricator login page (the link shows as an arrow to a door in the top right when you're logged out).
  • Click the sunflower button that says "Login or Register - MediaWiki".
  • You will be asked by MediaWiki.org to approve connecting.
  • Phabricator will ask you for a username. In case of doubt, just use your Wikimedia username, but note that Phabricator username cannot include non-Latin characters such as العَرَبِيةُ or 中华民族. A valid email address will also be required for verification, but not shown to other users.
  • Click on Manage in the navigation bar on the left.
  • Click Edit Profile and set your Also Known As (for example, to your full name) to make it easier to search for you.
Advanced
If you have a wikitech.wikimedia.org account — also known as an LDAP account or Gerrit account — you can also use that to log in. The same Phabricator username can have both MediaWiki.org and LDAP connected. This can be a backup, in the unlikely event Wikimedia SUL is not working. Connect your Wikimedia SUL and LDAP accounts to a single Phabricator username! Otherwise you will create two separate Phabricator accounts.
We do not encourage using multi-factor authentication on Wikimedia Phabricator. If you still plan to use it, read the multi-factor authentication guidelines and requirements first.

Claiming your previous Bugzilla and RT accounts[edit]

Follow the link here.

Notifications[edit]

Receiving updates and notifications[edit]

Subscribing to a single task
Watching a project to receive its notifications

Phabricator notifies you about relevant activity, including your own actions. You can fine-tune your email preferences to your taste, receiving web notifications only for certain activities, or no notifications at all.

Phabricator offers several tools to receive the notifications you wish to receive.

  • If you are interested in a single object (a task, a mockup...) just click Subscribe in its page. Adding a comment will subscribe you automatically.
  • If you are interested in all the activity within a project, you can click Watch Project on the project summary page. There is more information in the Projects user guide under "Watching Projects".

You can also define in your Email preferences for which specific actions (e.g. status, owner, priority or subscriber changes) in a task you would like to (not) receive notifications. Prolific users might want to reduce email settings to a minimum, such as in File:Phabricator email settings panel.png. As a project member, you can opt out of project mail via the Disable Mail on the project's Members page. There is more information in the Managing Phabricator Email user guide.

Creating Herald rules for notifications[edit]

Follow this link to learn how to create custom (personal) notification rules in Wikimedia Phabricator's Herald. This is a more advanced option and can be difficult to use.

Creating a task[edit]

Ways to create a task.
How to edit a task already created.

There are several ways to create a task, depending on the information you want to carry:

  • A new task: click the Star button toward the right side of the top navigation bar. From the dropdown menu, choose Create Task. You will get a blank form.
  • A security problem: click the Star button toward the right side of the top navigation bar. From the dropdown menu, choose Report Security Issue. You will get a form pre-tagged with Security, and with a link to special instructions for filing security bugs.
  • A subtask of an existing task: click Edit Related Tasks… > Create Subtask located in the right column of the current task. The dependency between both tasks will be set, and some values of the parent task will be carried by default (Assigned To, Subscribers, Priority, Projects). Subtasks will be listed in the parent task under "Task Graph", sorted by most recently updated.

Fill the form, leaving the fields you are not sure about unchanged.

Formatting[edit]

Phabricator supports some formatting in text areas. See this help about formatting in Phabricator.

Selecting projects[edit]

In order to relate a task with a project (tag) that uses Phabricator, you just need to start typing its name in the Tags field and select the project from the list of matching projects (the list will only show five matching projects). You can search for projects and read short project descriptions by clicking the magnifier icon in the Tags field. You can add one or more projects to the Tags field. If you are unsure, you can also leave it empty — triagers will take care of tasks that have no project set. There is a (long) list of projects available. Press Edit Query to search for projects. (This list is also available at Phabricator/Projects.)

Setting task priority[edit]

Priority should normally be set by product managers, maintainers, or developers who plan to work on the task, or by the bugwrangler or experienced community members, not by the reporter filing the bug report or by outside observers. See Phabricator project management for details.

Using email[edit]

You can also create tasks by sending email to task@phabricator.wikimedia.org. The subject will be used as task title, the body will be used directly as is, and attachments will be included on the task. To set a project, add the corresponding command "!projects" and its hashtag at the beginning of the body, e.g., !projects #mediawiki-core. Further commands to set the task assignee, priority or status via email are available.

Note: if your email signature is not formatted following de facto standards (including "-- " to be separated from the body text) it will be posted as well. You are encouraged to remove private information from your signature in your first attempt, just to be sure.

Passing certain values in the task creation URL[edit]

"Report a bug in Phabricator" link can pass numerous values via URL parameters appended to the generic task creation link.

This is a very advanced feature. Learn more here.

Writing comments and descriptions[edit]

How to format the text that you write in a comment and how to use lists and headers.
There are several actions that you can perform at the same time that you comment.

Phabricator allows you to post and edit comments and descriptions using text formatting and inserting images or other files; see Uploading file attachments. You can use toolbar at the top of the input text area and you can use Phabricator's Remarkup.[1] At the end of the page you have a live preview to check whether your text looks as you expect. Popular use of markup includes:

  • Mentioning users as in @username will create a link to their profile and will subscribe them to the task.
  • Adding a task number as in T123 will create a link to the task including a hover card. {T123} inserts the title of the task in your text.
  • Adding a project name as in #Project will create a link to the project main page.
  • If you want to quote text, you can simply add ">" at the beginning. If you want to reply a comment including it as a quote, click the drop down arrow at the right end of the comment you want to reply.
  • If you want to display an uploaded mockup image file, e.g., like M123, embedded in your comment, write {M123}.
  • If you want to create an external link, e.g. [https://www.mediawiki.org example] in wiki markup, use [[ https://www.mediawiki.org | example ]] including the whitespaces in Phabricator.
  • If you want to add a web address (URL link) in a comment for example to provide a testcase, it is highly recommended to copy and paste the full web address from your web browser's address bar, e.g., https://www.mediawiki.org/wiki/Project:Support_desk instead of mw:Project:Support desk. Interwiki prefixes like mw: are not supported in Phabricator and most customizations that Bugzilla had neither, e.g., Gerrit changes should be pasted as full web addresses too.
  • If you want to paste lines of code, add a line with three backticks before and after the code: ```. Or create a Paste and link to the Paste from the task.

Note that Phabricator's own markup language is different from MediaWiki's markup. The upstream Phabricator instance hosts a Remarkup Reference for Phabricator's own markup language.[1]

Uploading file attachments[edit]

دوتنې څنگه پورته کولی شم.

There are several ways to upload files: You can add a file (for example a screen photo) to a comment or a task description via drag and drop with your mouse. Users can also copy and paste images via the clipboard functionality of their system.

If this is not available on your system you can use phabricator:file/upload and refer to the file number (like "123") that is shown after a successful upload by writing F123 in a comment. This will create a link to the file. To include the file in the comment, enclose the ID in braces: {F123}. Per default it's included as thumbnail. For more formatting options, visit Remarkup reference. If you have to upload files frequently and consider the currently available options uncomfortable, you could also add a text panel to your homepage with a direct link.

Advanced users could also use "arc upload" which provides an F number that can be used via {Fxx} syntax to embed in a comment.

Note that you cannot upload a file and then decrease the access level to the file (e.g linking it to a restricted security ticket). You would have to delete the file and reupload it with stricter access permissions. It is recommended to upload files which should have restricted access together with the creation of a restricted (security) ticket.

If you ever need to delete a file that you uploaded, open the phabricator:file/ overview, select "Authored", select the file and click "Delete File" in the sidebar.

Project management in Phabricator[edit]

If you maintain or manage a project, please follow this link for more details.

Parent tasks and subtasks[edit]

Tasks can be a parent task or a subtask of any number of other tasks. Such relations can be set via "Edit Related Tasks...". This feature can be used to accomplish a few different things:

  • Blockers and Subtasks. A (parent) task might simply be blocked by another (sub)task, representing a dependency (see Phabricator/Project management#Tasks that cannot be worked on yet on how to add a subtask).
  • Tracking. A "workless" (parent) task blocked by several (sub)tasks might be tracking a collection of (sub)tasks within a release or other time period (see #"Tracking" Tasks below).
  • Approval. Several (parent) tasks (such as draft team goals) might be blocked by a single (sub)task which represents the draft tasks getting approved, after which those draft goals are now real goals.

Parent tasks and subtasks are displayed under "Task Graph" in the task. NOTE: There is a "Edit Related Tasks... > Create Subtask" feature. In addition to setting up the correct parent/subtask relationship, it also caries the CC (subscription) list into the new subtask.

Prioritization[edit]

Each Task has a Priority field, which is reflected in the sidebar color of Tasks that appear in Workboards. Note that this Priority is inherent to the Task, and thus will be the same in every Project and Workboard that task appears in.

Within a Workboard, Tasks can be arranged in a priority order within a column. Choose "Natural" sort, and then drag-and-drop Tasks up or down within a column. This allows a groomed backlog to be sequenced by priority, or could indicate the urgency of items in a "Needs Review" column. Note that Workboard columns can also be sorted by the underlying Priority field, so while discussing a Workboard with someone not in the room, it is best to agree on and use the same sort order to avoid confusion.

Assignment[edit]

Each Task may be assigned to one person. As with Priority, this is inherent to the Task, and affects every Project that Task is in. So it is impossible to have a Task assigned to Robin in one Project, but to Kim in another. The assigned person is displayed as part of the Task card in each Workboard.

Some teams might choose to assign Tasks to people while the Tasks are in a TODO column. Others would have people assign Tasks to themselves only at the moment that they are moving them from TODO to DOING. Assigning a Task to yourself before you are ready to work on it is a form of "cookie licking".

After the main work on a Task is finished, there are 2 main patterns for assignment:

  • The Task remains assigned to whoever did the work, as that task's permanent owner
  • The Task gets reassigned to whoever needs to work on it next

So for example, after code has been written, it might needs a code review from some specific person. In the second case, the Task would be assigned to that person, making it clear who is responsible for moving that task forward. Obviously if there are multiple possible code reviewers, that model would not work. Later, if the issue were waiting for someone to test it, or deploy it, or to run some specific task necessary for the Task to be completed (like a re-index), the Task could be assigned to that person. A team might have a policy that completed tasks should get assigned back to the person who originally created them, so that person can verify that their needs were met, and the task is ready to be closed.

"ترسره شوي"[edit]

Each Task has a Status field, which includes the state of Resolved. Resolved tasks are by default hidden from Workboards. When they are displayed, they appear grayed out and struck out. Other statuses include Open and Stalled.

Note that this Resolved status is inherent to the Task, and so will affect that Task's appearance and behavior in every Project (and Workboard) it is in. This is independent of which column a Task might be in, in any given Workboard. So a Task could be Open, and could be in the DONE column of one Workboard, but the DOING column of another. It could also be in the 2018 column somewhere else.

As a result, it is important not to mark a task Resolved until it is considered done by ALL of the projects it is in. It's fine to move a Task to your own Workboard's DONE column, but before you mark a task Resolved, ensure that no other project still wants to keep tracking its progress.

"Tracking" tasks[edit]

This term was brought over from Bugzilla, where it had a specific meaning: A task which was blocked on other tasks, but which itself did not represent any work, and which was not tied to a specific release/date. An example might be a Task named "Clean up the documentation", which might then have a variety of subtasks, each of which would describe specific work to be done. These "Tracking" Tasks tended to stick around for a long time (or forever), as their subtasks would get resolved but new ones would get created. In Phabricator, it would be better to create a Project (tag) to categorize this type of work.

Note, however, that there are other types of work-less umbrella tasks which do still make sense in Phabricator. Notably, "Release" tasks. An upcoming release could be represented by a Task, which lists as subtasks all the actual work tasks which are targeted for that release. Once the release goes out, it can be resolved. A similar use would be to have a task which represents a teams overall goals for the quarter, and then each goal might (or might not) be a blocking subtask.

Searching for items[edit]

Warning Warning: In early 2017, search was switched to a different backend (ElasticSearch). Content in this section is likely no longer relevant or unstable.
Using Phabricator's basic search field in the upper corner

Phabricator consists of several applications (task management in "Maniphest" being one of them, and in the future also Diffusion and Differential for code review). The search field in the upper corner allows searching across all these applications. This is a detailed description of the basic search options in Phabricator. The generic search is found in the upper right of every Phabricator page.

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. 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, set "Current viewer".

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

Search terms[edit]

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

As of 2017, Phabricator is using the ElasticSearch full-text search engine which is based on Apache Lucene. In-depth knowledge of it might help searching better. Some locally-valid properties:

  • Case insensitive: Edit is the same as eDIt
  • phrase search works: "fatal error"
  • basic tokenization is performed, e.g. to strip punctuation
  • only whole-word matches are returned by default and no morphological analysis is performed: "edited" is only found by edited, not by edit and even less by edits
  • Prefix / wildcard search is possible: fatal error* will match documents with the word "errors"
  • Boolean queries are possible by using the + and - symbols before each term. E.g. -non +fatal +error to exclude "non-fatal" errors from results. There is a detailed description of the query syntax in the ElasticSearch Query String documentation.
  • Documents matching all words are ranked higher than partial patches. The query passed to the search engine is a combination of a boolean AND with a boolean OR query, so a search for fatal error (without quotes) is converted to something like this: "fatal error" OR (fatal AND error) OR (fatal OR error) and results are ranked according to whether the exact phrase matched, followed by whether the AND query matched, followed finally by any results matching the OR query.

People who don't remember the exact words used in an item they are looking for usually follow one of these paths:

  • 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;
  • use the Bugzilla search for tasks created before November 2014 and their edits before November 2014 (docs, tips, more tips);
  • file a new task, mentioning that a past report exists as well, and wait for someone to merge the new report to the old.

Searching for tasks and bug reports[edit]

There are 2 different main task search forms:

There is also an advanced search for some of the other applications (e.g. phab:file/query/advanced). To only search for tasks / bug reports, use the Maniphest advanced search.

The advanced search forms are not explicit about the logic they use. In general, they seem to use OR within a field (except words), AND between different fields. It's sometimes possible to specify in a field "in any", "not in", via the auto-completion suggestions.

Maniphest offers links to some predefined search queries. For example, click authored to get a list of tasks that you have created.

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. (Searching for tasks that got closed within a certain timeframe is not supported — use Reports as a workaround by setting the "Recently Means" value and checking the "Recently Closed" column for your product.)

Defining your default search context[edit]

By default, the search field in the top bar of Phabricator searches 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.

Finding the Maniphest task corresponding to a Bugzilla bug number[edit]

All Phabricator tasks migrated 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.

Using Maniphest (Advanced Search)[edit]

Using Maniphest's advanced search

Maniphest is a tool which allows users to make detailed queries. Users can refine a query using multiple parameters. Queries can also be saved and managed.

New users will find several saved queries preset inside Maniphest. Clicking on the "Advanced Search" will bring up a new search page.

Click here for a detailed Maniphest walkthrough.

Advanced features[edit]

Using Dashboards[edit]

Dashboards are specially designed home pages which can display a wide range of custom information. They can be created, managed and shared between users.

Click here for a detailed Dashboard walkthrough.

Batch edits[edit]

Phabricator offers the possibility to perform mass/bulk edits for tasks. At the end of any Maniphest search query you will find a "Batch Edit Selected" to edit all the tasks you have selected using Shift-click. Users willing to use this feature need to join the Triagers group.

Batch-editing is not typically easily reversed, especially the larger the batch. To mitigate this, you can manipulate the URL of a prepared batch edit, and capture the task IDs in the batch. Do this before executing the batch, by copying the "?ids=" part of the URL in the prep stage of a batch change (and it is not possible not after, so when in doubt do it). If you apply that to a Maniphest query, you get the IDs, and can save the query or the URL for later use. See also this this comment for a hack to bulk edit tasks on a workboard.

Favorites[edit]

The Star menu in the top navigation bar can be customized with links to your preferred forms and actions. See the Profile Menu instructions for more information.

Personal lists of items[edit]

The "Flag For Later" functionality offers marking objects (like tasks or revisions) which "you want to remember to look at later". Eight flag colors are available. Flags are personal and private so your lists cannot be shared with others. Your flagged objects are listed on flag. They can be searched by color or object type, in contrast to tokens.

Creating a project[edit]

Screencast showing how to request a project

In Phabricator projects are tags, tags are projects. Hierarchy via sub-projects is available since February 2016.[2] Tasks can be assigned to more than one project, and they can also be submitted without assigning them to any project.

When do you need a project?[edit]

In general, you need a project...

  • when you have an established team running one or several projects (start here, ask more only when you need more)
  • when you need a workboard (i.e. a sprint)
  • when you need a tag or keyword to organize a type of task that can be part of any project (for example "Accessibility")

Requesting a new project[edit]

See Phabricator/Requesting a new project.

Restricting access to tasks[edit]

Please see Phabricator/Security for a general overview and for the "Security" dropdown option in tasks. See Phabricator/Creating and renaming projects#Policy for default project settings (and using Spaces).

Displaying and using a Space[edit]

Task creation view when having access to at least two 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.

Task view when the task is in a non-public Space
Workboard view of two tasks in a non-public Space

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 templates and links[edit]

  • You can link to Phabricator tasks from wiki pages using phabricator: and its shorter version phab:, for instance [[phab:T454|example]] generates example.
  • Template:Tracked has been updated to include links to Phabricator objects — see at the right how {{Tracked|T177|resolved}} is rendered.
  • Template:Phabricator is also available; {{Phabricator|T176}} generates task T176.

Existing Bugzilla links and templates will still work, because those links will continue to point to bugzilla.wikimedia.org which will redirect them to the converted Phabricator task.

Using Conpherence[edit]

Conpherence is a Phabricator application that enables private conversations between two or more users, similar to instant messaging and private chat rooms. No team is known to use this. It may conflict with other communication channels. To learn more click here.

Conpherence has an optional persistent window/column that can be shown and hidden with the keyboard key "\". Users may accidentally activate this feature, and it can only be hidden again by using the "\" key (there is no graphical UI feature to close it).

شمارنې[edit]

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.[3] Phragile and Phlogiston are further reporting tool options for Phabricator.

Diffusion[edit]

Diffusion is the Phabricator repository browser[4] and repository management tool. Eventually we want to replace Gerrit for code review and repository management, and gitblit for repository read-only mirroring. Right now, we're mirroring some of our Git repositories to Phabricator for demonstration purposes.

Forms[edit]

Phabricator allows some customization of the fields shown for a given task. These are handled via the Forms feature.

نورې تړنې[edit]

  1. 1.0 1.1 Remarkup Reference, on the upstream Phabricator instance
  2. T3670 (subprojects), on the upstream Phabricator instance
  3. T1562 (statistics), on the upstream Phabricator instance
  4. Diffusion repository browser user guide, on the upstream Phabricator instance