Differential D89 Diff 198 source/contributor-guide/getting-started.rst

Changeset View

Standalone View

source/contributor-guide/getting-started.rst

This file was added.

				.. _contributor-guide-getting-started:

				================================
				Getting Started with Phabricator
				================================

				#. Navigate to https://git.kolab.org. We recommend you use a browser.

				#. Determine whether you are a Kolab Systems employee, and act accordingly;

				#. If you are a Kolab Systems employee, use your corporate credentials to
				login using LDAP.

				#. If you are not a Kolab Systems employee, create yourself an account if
				you have not already done so. You can use any of the forms except for
				the one that requests LDAP credentials.

				#. `Set your date-time notation format <https://git.kolab.org/settings/panel/datetime>`_.

				#. Set your profile picture.

				#. `Upload an SSH public key <https://git.kolab.org/settings/panel/ssh/>`_.

				#. `Set your text-area font to fixed width <https://git.kolab.org/settings/panel/display/>`_.

				#. `Configure email notifications <https://git.kolab.org/settings/panel/emailpreferences/>`_,
				especially the ones for actions you place yourself.

				#. :ref:`contributor-guide-setup-tools`.

				#. Hook up arcanist to your Phabricator account:

				.. parsed-literal::

				$ :command:`arc install-certificate`

				Projects
				========

				Software development projects use a communication icon (envelope) in
				:blue:`blue`.

				Each software development project is provided a workboard, such they could, at
				their option, visualize a roadmap.

				.. NOTE::

				The use of sub-projects and milestones in Phabricator is under review.

				Teams
				=====

				Teams include groups of people that work on software development projects, or
				form the :red:`Architecture & Design` team, :red:`Release Managers`, etc.

				Membership of these teams usually provides you with commit access to a GIT
				repository, and is used to authorize differentials in
				:ref:`contributor-guide-peer-review`.

				* Software developer teams are used to authorize commit access, and use a group icon in :red:`red`.

				* You need to request membership from one of the existing members.

				* You only need membership in order to push to the GIT repositories directly.

				Sprints
				=======

				Sprints are time-boxed team efforts with the duration of exactly one week --
				running from Monday morning to Friday afternoon.

				TODO: More about sprints

				petersenUnsubmitted Not Done Inline Actions Perhaps not "a lot" more. I think it is an excellent definition you put up here. petersen: Perhaps not "a lot" more. I think it is an excellent definition you put up here.
				vanmeeuwenAuthorUnsubmitted Not Done Inline Actions I meant to say more about working with a sprint in Phabricator specifically -- so; the workboard with Backlog, Doing, Review, Done, Task status changes when moving to Done (basically release manager / merge window / ... setting the status to Resolved after retrospective), A differential being submitted for Review moving the task associated with it to the Review column, ... That sort of thing. vanmeeuwen: I meant to say more about working with a sprint in Phabricator specifically -- so; * the…
				Release Targets
				===============

				Release targets are irrelevant for developers. The only release target that is
				relevant for developers is :orange:`Winterfell`.

				Distributions
				=============

				Distributions (target platforms) are irrelevant for developers. The only target
				platform relevant to developers is :gray:`Maipo` (Enterprise Linux 7).