From 9a9df74ddb34068d5b09b26a3b9c327fab0f508e Mon Sep 17 00:00:00 2001 From: Joshua Spence Date: Mon, 8 Jun 2015 11:36:40 +1000 Subject: [PATCH] Minor documentation improvements Summary: Tidying up of documentation, adding some new groups. Test Plan: Eyeball it. Reviewers: #blessed_reviewers, epriestley Reviewed By: #blessed_reviewers, epriestley Subscribers: Korvin, epriestley Differential Revision: https://secure.phabricator.com/D13133 --- src/docs/book/contributor.book | 16 ++--- src/docs/book/flavor.book | 24 ++++---- src/docs/book/phabricator.book | 106 ++++++++++++++++++++++++++++----- src/docs/book/user.book | 28 ++------- 4 files changed, 117 insertions(+), 57 deletions(-) diff --git a/src/docs/book/contributor.book b/src/docs/book/contributor.book index 776417aa6d..d5b2ae90ae 100644 --- a/src/docs/book/contributor.book +++ b/src/docs/book/contributor.book @@ -11,13 +11,13 @@ }, "exclude": [ "(^externals/)", - "(^webroot/rsrc/externals/)", - "(^scripts/)", - "(^support/)", "(^resources/)", - "(^src/docs/user/)", + "(^scripts/)", + "(^src/docs/flavor/)", "(^src/docs/tech/)", - "(^src/docs/flavor/)" + "(^src/docs/user/)", + "(^support/)", + "(^webroot/rsrc/externals/)" ], "groups": { "contrib": { @@ -26,11 +26,11 @@ "detail": { "name": "Contributing in Detail" }, - "standards": { - "name": "Coding Standards" - }, "developer": { "name": "Developer Guides" + }, + "standards": { + "name": "Coding Standards" } } } diff --git a/src/docs/book/flavor.book b/src/docs/book/flavor.book index b13ed9956c..978244f19d 100644 --- a/src/docs/book/flavor.book +++ b/src/docs/book/flavor.book @@ -11,23 +11,20 @@ }, "exclude": [ "(^externals/)", - "(^webroot/rsrc/externals/)", - "(^scripts/)", - "(^support/)", "(^resources/)", - "(^src/docs/user/)", + "(^scripts/)", + "(^src/docs/contributor/)", "(^src/docs/tech/)", - "(^src/docs/contributor/)" + "(^src/docs/user/)", + "(^support/)", + "(^webroot/rsrc/externals/)" ], "groups": { "overview": { "name": "Overview" }, - "review": { - "name": "Revision Control and Code Review" - }, - "sundry": { - "name": "Sundries" + "javascript": { + "name": "Javascript" }, "lore": { "name": "Phabricator Lore" @@ -35,8 +32,11 @@ "php": { "name": "PHP" }, - "javascript": { - "name": "Javascript" + "review": { + "name": "Revision Control and Code Review" + }, + "sundry": { + "name": "Sundries" } } } diff --git a/src/docs/book/phabricator.book b/src/docs/book/phabricator.book index 0fc945f04e..ed74ddd012 100644 --- a/src/docs/book/phabricator.book +++ b/src/docs/book/phabricator.book @@ -7,20 +7,32 @@ "uri.source": "https://secure.phabricator.com/diffusion/P/browse/master/%f$%l", "rules": { - "(\\.php$)": "DivinerPHPAtomizer", - "(\\.diviner$)": "DivinerArticleAtomizer" + "(\\.diviner$)": "DivinerArticleAtomizer", + "(\\.php$)": "DivinerPHPAtomizer" }, "exclude": [ "(^externals/)", - "(^webroot/rsrc/externals/)", - "(^scripts/)", - "(^support/)", "(^resources/)", - "(^src/docs/user/)", + "(^scripts/)", + "(^src/docs/contributor/)", "(^src/docs/flavor/)", - "(^src/docs/contributor/)" + "(^src/docs/user/)", + "(^support/)", + "(^webroot/rsrc/externals/)" ], "groups": { + "aphront": { + "name": "Aphront", + "include": "(^src/aphront/)" + }, + "almanac": { + "name": "Almanac", + "include": "(^src/applications/almanac/)" + }, + "aphlict": { + "name": "Aphlict", + "include": "(^src/applications/aphlict/)" + }, "arcanist": { "name": "Arcanist Integration", "include": "(^src/applications/arcanist/)" @@ -45,6 +57,10 @@ "name": "Calendar", "include": "(^src/applications/calendar/)" }, + "celerity": { + "name": "Celerity", + "include": "(^src/applications/celerity/)" + }, "chatlog": { "name": "Chatlog", "include": "(^src/applications/chatlog/)" @@ -61,13 +77,28 @@ "name": "Conpherence", "include": "(^src/applications/conpherence/)" }, + "console": { + "name": "Console", + "include": "(^src/applications/console/)" + }, "countdown": { "name": "Countdown", "include": "(^src/applications/countdown/)" }, + "customfield": { + "name": "Custom Fields", + "include": "(^src/infrastructure/customfield/)" + }, "daemon": { "name": "Daemons", - "include": "(^src/applications/daemon/)" + "include": [ + "(^src/applications/daemon/)", + "(^src/infrastructure/daemon/)" + ] + }, + "dashboard": { + "name": "Dashboard", + "include": "(^src/applications/dashboard/)" }, "differential": { "name": "Differential", @@ -77,10 +108,6 @@ "name": "Diffusion", "include": "(^src/applications/diffusion/)" }, - "directory": { - "name": "Directory", - "include": "(^src/applications/directory/)" - }, "diviner": { "name": "Diviner", "include": "(^src/applications/diviner/)" @@ -97,6 +124,14 @@ "name": "Drydock", "include": "(^src/applications/drydock/)" }, + "edges": { + "name": "Edges", + "include": "(^src/infrastructure/edges/)" + }, + "events": { + "name": "Events", + "include": "(^src/infrastructure/events/)" + }, "fact": { "name": "Fact", "include": "(^src/applications/fact/)" @@ -113,6 +148,10 @@ "name": "Flags", "include": "(^src/applications/flag/)" }, + "fund": { + "name": "Fund", + "include": "(^src/applications/fund/)" + }, "harbormaster": { "name": "Harbormaster", "include": "(^src/applications/harbormaster/)" @@ -125,6 +164,10 @@ "name": "Herald", "include": "(^src/applications/herald/)" }, + "home": { + "name": "Home", + "include": "(^src/applications/home/)" + }, "legalpad": { "name": "Legalpad", "include": "(^src/applications/legalpad/)" @@ -142,17 +185,25 @@ "include": "(^src/applications/maniphest/)" }, "meta": { - "name": "Meta", + "name": "Applications", "include": "(^src/applications/meta/)" }, "metamta": { "name": "MetaMTA", "include": "(^src/applications/metamta/)" }, + "multimeter": { + "name": "Multimeter", + "include": "(^src/applications/multimeter/)" + }, "notification": { "name": "Notifications", "include": "(^src/applications/notification/)" }, + "nuance": { + "name": "Nuance", + "include": "(^src/applications/nuance/)" + }, "oauthserver": { "name": "OAuth Server", "include": "(^src/applications/oauthserver/)" @@ -161,6 +212,10 @@ "name": "Owners", "include": "(^src/applications/owners/)" }, + "passphrase": { + "name": "Passphrase", + "include": "(^src/applications/passphrase/)" + }, "paste": { "name": "Paste", "include": "(^src/applications/paste/)" @@ -193,6 +248,10 @@ "name": "PHPAST", "include": "(^src/applications/phpast/)" }, + "phragment": { + "name": "Phragment", + "include": "(^src/applications/phragment/)" + }, "phrequent": { "name": "Phrequent", "include": "(^src/applications/phrequent/)" @@ -201,6 +260,10 @@ "name": "Phriction", "include": "(^src/applications/phriction/)" }, + "phui": { + "name": "PHUI", + "include": "(^src/view/phui/)" + }, "policy": { "name": "Policy", "include": "(^src/applications/policy/)" @@ -219,7 +282,10 @@ }, "remarkup": { "name": "Remarkup", - "include": "(^src/applications/remarkup/)" + "include": [ + "(^src/applications/remarkup/)", + "(^src/infrastructure/markup/)" + ] }, "repository": { "name": "Repositories", @@ -237,10 +303,22 @@ "name": "Slowvote", "include": "(^src/applications/slowvote/)" }, + "spaces": { + "name": "Spaces", + "include": "(^src/applications/spaces/)" + }, + "storage": { + "name": "Storage", + "include": "(^src/infrastructure/storage/)" + }, "subscriptions": { "name": "Subscriptions", "include": "(^src/applications/subscriptions/)" }, + "support": { + "name": "Support", + "include": "(^src/applications/support/)" + }, "system": { "name": "System", "include": "(^src/applications/system/)" diff --git a/src/docs/book/user.book b/src/docs/book/user.book index 18b6c6db6c..e6f44abe36 100644 --- a/src/docs/book/user.book +++ b/src/docs/book/user.book @@ -11,13 +11,13 @@ }, "exclude": [ "(^externals/)", - "(^webroot/rsrc/externals/)", - "(^scripts/)", - "(^support/)", "(^resources/)", - "(^src/docs/tech/)", + "(^scripts/)", + "(^src/docs/contributor/)", "(^src/docs/flavor/)", - "(^src/docs/contributor/)" + "(^src/docs/tech/)", + "(^support/)", + "(^webroot/rsrc/externals/)" ], "groups": { "intro": { @@ -28,24 +28,6 @@ }, "userguide": { "name": "Application User Guides" - }, - "differential": { - "name": "Differential (Code Review)" - }, - "diffusion": { - "name": "Diffusion (Repository Browser)" - }, - "maniphest": { - "name": "Maniphest (Task Tracking)" - }, - "slowvote": { - "name": "Slowvote (Polls)" - }, - "herald": { - "name": "Herald (Notifications)" - }, - "phriction": { - "name": "Phriction (Wiki)" } } }