From a88e132179a5b02688384ca9a9ab32cc331dba0d Mon Sep 17 00:00:00 2001
From: epriestley <git@epriestley.com>
Date: Thu, 12 Jan 2012 18:30:36 -0800
Subject: [PATCH] Minor documentation improvements
Summary:
- Link to "importing a repository" from Config next steps, since it's not
obvious (and the article isn't obviously named).
- Some minor doc tweaks.
- Remove "Roadmap" document since it's super out of date and not very useful.
Test Plan: Regenerated and read documentation.
Reviewers: btrahan, jungejason
Reviewed By: jungejason
CC: aran, jungejason
Maniphest Tasks: T743
Differential Revision: https://secure.phabricator.com/D1384
---
.../configuration/configuration_guide.diviner | 1 +
src/docs/contributing/contrib_intro.diviner | 17 ++++-
src/docs/introduction.diviner | 7 ++-
src/docs/roadmap.diviner | 63 -------------------
src/docs/userguide/diffusion.diviner | 12 ++--
5 files changed, 25 insertions(+), 75 deletions(-)
delete mode 100644 src/docs/roadmap.diviner
diff --git a/src/docs/configuration/configuration_guide.diviner b/src/docs/configuration/configuration_guide.diviner
index 02473da22a..74807f6689 100644
--- a/src/docs/configuration/configuration_guide.diviner
+++ b/src/docs/configuration/configuration_guide.diviner
@@ -155,5 +155,6 @@ Continue by:
- configuring Phabricator so it can send mail with
@{article:Configuring Outbound Email}; or
- configuring inbound mail with @{article:Configuring Inbound Email}; or
+ - importing repositories with @{article:Diffusion User Guide}; or
- learning about daemons with @{article:Managing Daemons with phd}; or
- contributing to Phabricator with @{article:Contributor Introduction}.
\ No newline at end of file
diff --git a/src/docs/contributing/contrib_intro.diviner b/src/docs/contributing/contrib_intro.diviner
index 9d3d81eeb8..8ecedc479d 100644
--- a/src/docs/contributing/contrib_intro.diviner
+++ b/src/docs/contributing/contrib_intro.diviner
@@ -21,9 +21,20 @@ https://developers.facebook.com/opensource/cla
If you want to contribute but aren't sure how (or want to try submitting a small
patch before you build something bigger) you can search the Phabricator
-development install for open tasks in the "Bootcamp" project which are owned by
-"Up For Grabs". These are small-to-medium-sized bugs and projects intended to
-introduce new contributors to the codebase.
+development install for open tasks (these are pretty up-to-date) or come find
+us in IRC and ask for some pointers.
+
+= Submitting Patches =
+
+To submit patches against libphutil, Arcanist or Phabricator, create a commit
+and use ##arc## to send it for review (probably with ##epriestley## as a
+reviewer):
+
+ $ arc diff
+
+When your change is accepted, send a pull request on GitHub. (You can also
+just submit a pull request, but Differential is preferred for nontrivial
+changes.)
= Suggested Reading =
diff --git a/src/docs/introduction.diviner b/src/docs/introduction.diviner
index 3e545db90e..cbd739fc8d 100644
--- a/src/docs/introduction.diviner
+++ b/src/docs/introduction.diviner
@@ -13,7 +13,8 @@ The major components of Phabricator are:
- **Differential**, a code review tool; and
- **Diffusion**, a repository browser; and
- - **Maniphest**, a bug tracker.
+ - **Maniphest**, a bug tracker; and
+ - **Phriction**, a wiki.
Phabricator also includes a number of smaller tools.
@@ -30,8 +31,8 @@ However, Phabricator may also not be a good solution for you:
- If you develop primarily on Windows, you are likely to find integration
with the toolsets you use lacking.
- - If you don't use SVN or Git, you'll have to add support for your VCS before
- you can get anywhere.
+ - If you don't use SVN, Git or Mercurial, you'll have to add support for your
+ VCS before you can get anywhere.
- If you loathe PHP, well, it's written in PHP. Sorry. It is a victim of
circumstances. We assert it is well-written PHP, at least.
diff --git a/src/docs/roadmap.diviner b/src/docs/roadmap.diviner
deleted file mode 100644
index e1c5d23fb9..0000000000
--- a/src/docs/roadmap.diviner
+++ /dev/null
@@ -1,63 +0,0 @@
-@title Roadmap and Status
-@group intro
-
-Insight into the direction and progress of Phabricator. This document was last
-updated **September 14th, 2011**.
-
-= Status =
-
-Phabricator is in an early release stage, but quite usable. The project is under
-active development.
-
-= Current Development =
-
-The current focus on Phabricator is primarily feature buildout, particularly in
-these applications:
-
- - **Mercurial**: Mercurial support is actively landing.
- - **Maniphest**: A lot of early adopters are getting into the suite because
- of this tool, and we're continuing to improve it.
- - **Phriction**: We just landed a wiki application, which basically works but
- needs a bunch of improvements.
- - **Feed**: A rough cut of feed landed recently but needs a ton of work.
- - **Projects**: Projects are getting a bit more useful, but we want to
- continue adding features.
-
-= Future Development =
-
-Most of the future work also involves feature buildout. These are projects we're
-thinking about in a very early stage, and may not happen or may look completely
-different when we implement them:
-
- - **Hosted/Managed Repositories**: We're starting to develop some features to
- let Phabricator host or manage repositories, since this simplifies and
- unblocks some stuff we'd like to eventually build.
- - **Drydock**: Build infrastructure to let Phabricator manage working copies
- in a scalable way. This is a general piece of infrastructure which enables
- us to build a lot of features, like: sandcastle (your changes are
- automatically pushed to a machine and reviewers can access that machine to
- see them), asynchronous unit testing, watir/selenium testing,
- Differential-managed merging, and web bisect. This is difficult because
- "scalable" is very big and it needs to shard easily across a pool of
- machines. Facebook has a less general version of this which took a long time
- to get working, but it solved a lot of the hard problems so it may be less
- daunting for us.
- - **Testing**: Phabricator has very little test coverage right now and we'd
- like to improve it. But we also want to make sure we're designing the right
- test environment and solving problems like database stubbing in a robust
- way. Facebook ended up with some solutions in this space which had tradeoffs
- and downsides we'd like to avoid.
- - **Importers**: Unclear how much time we want to spend here, but providing
- ways to import from other bug tracking and code review systems could lower
- the barrier to adoption. But this could also be a massive timesuck.
- - **Evangelism**: Phabricator had an intentionally quiet launch because the
- install process wasn't any good and we wanted to get feedback (there were
- other reasons, as well). It's starting to get some traction and feedback
- from people have used it seems to be pretty positive. At some point it may
- be appropriate to spend more time evangelizing it.
- - **Mission**: Phabricator doesn't have a clear mission statement. Do we want
- to develop a revenue model around it? Do we want to actively compete with
- the many other products in this space? For now, improving the software is
- probably the most important thing we can do to achieve any of these goals,
- but we don't currently have a clear long-term vision.
-
diff --git a/src/docs/userguide/diffusion.diviner b/src/docs/userguide/diffusion.diviner
index e4a33dae7d..a0928ea9f8 100644
--- a/src/docs/userguide/diffusion.diviner
+++ b/src/docs/userguide/diffusion.diviner
@@ -8,12 +8,12 @@ Guide to Diffusion, the Phabricator repository browser.
Diffusion is a repository browser which allows you to explore source code in a
Git or SVN repository, similar to software like Trac and GitWeb.
-Diffusion provides a very high-performance SVN browser and a moderately
-high-performance Git browser. It achieves performance by denormalizing large
-amounts of data about repository history into a database and using this
-information like a cache so it can avoid querying the repository directly. This
-data is generated by daemons which track repositories, discover new commits, and
-parse and import them.
+Diffusion provides a very high-performance SVN browser, a moderately
+high-performance Git browser and relatively slow Mercurial browser. It achieves
+performance by denormalizing large amounts of data about repository history into
+a database and using this information like a cache so it can avoid querying the
+repository directly. This data is generated by daemons which track repositories,
+discover new commits, and parse and import them.
Diffusion is integrated with the other tools in the Phabricator suite. For
instance: