Skip to content

Commit 1bb055d

Browse files
author
epriestley
committed
Introduction doc.
Summary: Test Plan: Reviewers: CC:
1 parent 3b7d73c commit 1bb055d

File tree

3 files changed

+57
-1
lines changed

3 files changed

+57
-1
lines changed

.divinerconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name" : "Phabricator",
33
"src_base" : "https://github.com/facebook/phabricator/blob/master",
44
"groups" : {
5-
"overview" : "Overview",
5+
"intro" : "Introduction",
66
"install" : "Installing",
77
"config" : "Configuration",
88
"userguide" : "Application User Guides",
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?php
2+
/**
3+
* This file is automatically generated. Lint this module to rebuild it.
4+
* @generated
5+
*/
6+
7+
8+
9+
phutil_require_module('phabricator', 'aphront/console/plugin/base');
10+
phutil_require_module('phabricator', 'view/control/table');
11+
12+
phutil_require_module('phutil', 'markup');
13+
14+
15+
phutil_require_source('DarkConsoleConfigPlugin.php');

src/docs/introduction.diviner

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
@title Introduction
2+
@group intro
3+
4+
This document provides a high-level overview of the Phabricator project.
5+
6+
= What is Phabricator? =
7+
8+
**Phabricator** (pronounced like the word //fabricator//) is a suite of web
9+
applications which make it easier to build software, particularly when working
10+
with teams. Phabricator is largely based on Facebook's internal tools.
11+
12+
The major components of Phabricator are:
13+
14+
- **Differential**, a code review tool; and
15+
- **Diffusion**, a repository browser.
16+
17+
Phabricator also includes a number of smaller tools.
18+
19+
= Why use Phabricator? =
20+
21+
Phabricator gives you a box of reasonably decent tools for a comparatively small
22+
setup cost. Plus:
23+
24+
- It has some good project names.
25+
- Facebook integration makes it very hip indeed.
26+
- It's fairly snappy.
27+
- You only have to install and configure one thing instead of setting up
28+
and customizing a bunch of tools you don't really care about.
29+
- A couple of the core tools are actually pretty good.
30+
- Maniphest allows you to close tasks "out of spite".
31+
32+
However, Phabricator may also not be a good solution for you:
33+
34+
- If you develop primarily on Windows, you are likely to find integration
35+
with the toolsets you use lacking.
36+
- If you don't use SVN or Git, you'll have to add support for your VCS before
37+
you can get anywhere.
38+
- If you loathe PHP, well, it's written in PHP.
39+
40+
41+

0 commit comments

Comments
 (0)