diff --git a/src/docs/book/contributor.book b/src/docs/book/contributor.book new file mode 100644 index 0000000000..2960d4e439 --- /dev/null +++ b/src/docs/book/contributor.book @@ -0,0 +1,33 @@ +{ + "name" : "phabcontrib", + "title" : "Phabricator Contributor Documentation", + "short" : "Phabricator Contributor Docs", + "preface" : "Information for Phabricator contributors.", + "root" : "../../../", + "uri.source" : + "https://secure.phabricator.com/diffusion/P/browse/master/%f$%l", + "rules" : { + "(\\.diviner$)" : "DivinerArticleAtomizer" + }, + "exclude" : [ + "(^externals/)", + "(^webroot/rsrc/externals/)", + "(^scripts/)", + "(^support/)", + "(^resources/)", + "(^src/docs/user/)", + "(^src/docs/tech/)", + "(^src/docs/flavor/)" + ], + "groups" : { + "contrib" : { + "name" : "Contributor Overview" + }, + "standards" : { + "name" : "Coding Standards" + }, + "developer" : { + "name" : "Developer Guides" + } + } +} diff --git a/src/docs/book/flavor.book b/src/docs/book/flavor.book new file mode 100644 index 0000000000..92e5158ece --- /dev/null +++ b/src/docs/book/flavor.book @@ -0,0 +1,42 @@ +{ + "name" : "phabflavor", + "title" : "Phabricator Flavor Text", + "short" : "Flavor Text", + "preface" : "Recommendations, lore, and dark rituals.", + "root" : "../../../", + "uri.source" : + "https://secure.phabricator.com/diffusion/P/browse/master/%f$%l", + "rules" : { + "(\\.diviner$)" : "DivinerArticleAtomizer" + }, + "exclude" : [ + "(^externals/)", + "(^webroot/rsrc/externals/)", + "(^scripts/)", + "(^support/)", + "(^resources/)", + "(^src/docs/user/)", + "(^src/docs/tech/)", + "(^src/docs/contributor/)" + ], + "groups" : { + "overview" : { + "name" : "Overview" + }, + "review" : { + "name" : "Revision Control and Code Review" + }, + "sundry" : { + "name" : "Sundries" + }, + "lore" : { + "name" : "Phabricator Lore" + }, + "php" : { + "name" : "PHP" + }, + "javascript" : { + "name" : "Javascript" + } + } +} diff --git a/src/docs/book/phabricator.book b/src/docs/book/phabricator.book index 7b8c794d6b..cf363a647d 100644 --- a/src/docs/book/phabricator.book +++ b/src/docs/book/phabricator.book @@ -16,7 +16,9 @@ "(^scripts/)", "(^support/)", "(^resources/)", - "(^src/docs/user/)" + "(^src/docs/user/)", + "(^src/docs/flavor/)", + "(^src/docs/contributor/)" ], "groups" : { "arcanist" : { diff --git a/src/docs/book/user.book b/src/docs/book/user.book index 96c7df40a2..e05fb21f20 100644 --- a/src/docs/book/user.book +++ b/src/docs/book/user.book @@ -15,7 +15,9 @@ "(^scripts/)", "(^support/)", "(^resources/)", - "(^src/docs/tech/)" + "(^src/docs/tech/)", + "(^src/docs/flavor/)", + "(^src/docs/contributor/)" ], "groups" : { "intro" : { diff --git a/src/docs/user/developer/adding_new_css_and_js.diviner b/src/docs/contributor/adding_new_css_and_js.diviner similarity index 100% rename from src/docs/user/developer/adding_new_css_and_js.diviner rename to src/docs/contributor/adding_new_css_and_js.diviner diff --git a/src/docs/user/contributing/contrib_intro.diviner b/src/docs/contributor/contrib_intro.diviner similarity index 100% rename from src/docs/user/contributing/contrib_intro.diviner rename to src/docs/contributor/contrib_intro.diviner diff --git a/src/docs/user/developer/darkconsole.diviner b/src/docs/contributor/darkconsole.diviner similarity index 100% rename from src/docs/user/developer/darkconsole.diviner rename to src/docs/contributor/darkconsole.diviner diff --git a/src/docs/user/developer/database.diviner b/src/docs/contributor/database.diviner similarity index 100% rename from src/docs/user/developer/database.diviner rename to src/docs/contributor/database.diviner diff --git a/src/docs/user/contributing/general_coding_standards.diviner b/src/docs/contributor/general_coding_standards.diviner similarity index 99% rename from src/docs/user/contributing/general_coding_standards.diviner rename to src/docs/contributor/general_coding_standards.diviner index 0ed00f98d3..a2294d0e10 100644 --- a/src/docs/user/contributing/general_coding_standards.diviner +++ b/src/docs/contributor/general_coding_standards.diviner @@ -1,5 +1,5 @@ @title General Coding Standards -@group contrib +@group standards This document is a general coding standard for contributing to Phabricator, Arcanist, libphutil and Diviner. diff --git a/src/docs/user/contributing/internationalization.diviner b/src/docs/contributor/internationalization.diviner similarity index 99% rename from src/docs/user/contributing/internationalization.diviner rename to src/docs/contributor/internationalization.diviner index 56f7ac221d..25d790e808 100644 --- a/src/docs/user/contributing/internationalization.diviner +++ b/src/docs/contributor/internationalization.diviner @@ -1,5 +1,5 @@ @title Internationalization -@group contrib +@group developer What is required from developers to get Phabricator translatable. diff --git a/src/docs/user/contributing/javascript_coding_standards.diviner b/src/docs/contributor/javascript_coding_standards.diviner similarity index 99% rename from src/docs/user/contributing/javascript_coding_standards.diviner rename to src/docs/contributor/javascript_coding_standards.diviner index 8634e39caf..83772918c3 100644 --- a/src/docs/user/contributing/javascript_coding_standards.diviner +++ b/src/docs/contributor/javascript_coding_standards.diviner @@ -1,5 +1,5 @@ @title Javascript Coding Standards -@group contrib +@group standards This document describes Javascript coding standards for Phabricator and Javelin. diff --git a/src/docs/user/developer/n_plus_one.diviner b/src/docs/contributor/n_plus_one.diviner similarity index 100% rename from src/docs/user/developer/n_plus_one.diviner rename to src/docs/contributor/n_plus_one.diviner diff --git a/src/docs/user/developer/phabricator_code_layout.diviner b/src/docs/contributor/phabricator_code_layout.diviner similarity index 100% rename from src/docs/user/developer/phabricator_code_layout.diviner rename to src/docs/contributor/phabricator_code_layout.diviner diff --git a/src/docs/user/contributing/php_coding_standards.diviner b/src/docs/contributor/php_coding_standards.diviner similarity index 99% rename from src/docs/user/contributing/php_coding_standards.diviner rename to src/docs/contributor/php_coding_standards.diviner index cb3406e15b..78021a2f9f 100644 --- a/src/docs/user/contributing/php_coding_standards.diviner +++ b/src/docs/contributor/php_coding_standards.diviner @@ -1,5 +1,5 @@ @title PHP Coding Standards -@group contrib +@group standards This document describes PHP coding standards for Phabricator and related projects (like Arcanist and libphutil). diff --git a/src/docs/user/developer/rendering_html.diviner b/src/docs/contributor/rendering_html.diviner similarity index 100% rename from src/docs/user/developer/rendering_html.diviner rename to src/docs/contributor/rendering_html.diviner diff --git a/src/docs/user/developer/running_builtin_php_webserver.diviner b/src/docs/contributor/running_builtin_php_webserver.diviner similarity index 100% rename from src/docs/user/developer/running_builtin_php_webserver.diviner rename to src/docs/contributor/running_builtin_php_webserver.diviner diff --git a/src/docs/user/developer/unit_tests.diviner b/src/docs/contributor/unit_tests.diviner similarity index 100% rename from src/docs/user/developer/unit_tests.diviner rename to src/docs/contributor/unit_tests.diviner diff --git a/src/docs/user/developer/using_edges.diviner b/src/docs/contributor/using_edges.diviner similarity index 100% rename from src/docs/user/developer/using_edges.diviner rename to src/docs/contributor/using_edges.diviner diff --git a/src/docs/user/developer/using_oauthserver.diviner b/src/docs/contributor/using_oauthserver.diviner similarity index 100% rename from src/docs/user/developer/using_oauthserver.diviner rename to src/docs/contributor/using_oauthserver.diviner diff --git a/src/docs/user/flavortext/about_flavor_text.diviner b/src/docs/flavor/about_flavor_text.diviner similarity index 92% rename from src/docs/user/flavortext/about_flavor_text.diviner rename to src/docs/flavor/about_flavor_text.diviner index 17cc8d317b..3d46ff41d0 100644 --- a/src/docs/user/flavortext/about_flavor_text.diviner +++ b/src/docs/flavor/about_flavor_text.diviner @@ -1,5 +1,5 @@ @title About Flavor Text -@group flavortext +@group overview Explains what's going on here. diff --git a/src/docs/user/flavortext/javascript_object_array.diviner b/src/docs/flavor/javascript_object_array.diviner similarity index 99% rename from src/docs/user/flavortext/javascript_object_array.diviner rename to src/docs/flavor/javascript_object_array.diviner index fde8b33ecf..cf7e3371e6 100644 --- a/src/docs/user/flavortext/javascript_object_array.diviner +++ b/src/docs/flavor/javascript_object_array.diviner @@ -1,5 +1,5 @@ @title Javascript Object and Array -@group flavortext +@group javascript This document describes the behaviors of Object and Array in Javascript, and a specific approach to their use which produces basically reasonable language diff --git a/src/docs/user/flavortext/javascript_pitfalls.diviner b/src/docs/flavor/javascript_pitfalls.diviner similarity index 99% rename from src/docs/user/flavortext/javascript_pitfalls.diviner rename to src/docs/flavor/javascript_pitfalls.diviner index a4815e8f3a..fb9af3c197 100644 --- a/src/docs/user/flavortext/javascript_pitfalls.diviner +++ b/src/docs/flavor/javascript_pitfalls.diviner @@ -1,5 +1,5 @@ @title Javascript Pitfalls -@group flavortext +@group javascript This document discusses pitfalls and flaws in the Javascript language, and how to avoid, work around, or at least understand them. diff --git a/src/docs/user/flavortext/php_pitfalls.diviner b/src/docs/flavor/php_pitfalls.diviner similarity index 99% rename from src/docs/user/flavortext/php_pitfalls.diviner rename to src/docs/flavor/php_pitfalls.diviner index 81750a3afa..c51b459910 100644 --- a/src/docs/user/flavortext/php_pitfalls.diviner +++ b/src/docs/flavor/php_pitfalls.diviner @@ -1,5 +1,5 @@ @title PHP Pitfalls -@group flavortext +@group php This document discusses difficult traps and pitfalls in PHP, and how to avoid, work around, or at least understand them. diff --git a/src/docs/user/flavortext/please_please_please.diviner b/src/docs/flavor/please_please_please.diviner similarity index 98% rename from src/docs/user/flavortext/please_please_please.diviner rename to src/docs/flavor/please_please_please.diviner index 35c83cfa1e..2391a55ba3 100644 --- a/src/docs/user/flavortext/please_please_please.diviner +++ b/src/docs/flavor/please_please_please.diviner @@ -1,5 +1,5 @@ @title Please Please Please -@group flavortext +@group sundry Please read this document. diff --git a/src/docs/user/flavortext/project_history.diviner b/src/docs/flavor/project_history.diviner similarity index 99% rename from src/docs/user/flavortext/project_history.diviner rename to src/docs/flavor/project_history.diviner index ce4916dbc0..bfdbe2682e 100644 --- a/src/docs/user/flavortext/project_history.diviner +++ b/src/docs/flavor/project_history.diviner @@ -1,5 +1,5 @@ @title Phabricator Project History -@group flavortext +@group lore A riveting tale of adventure. In this document, I refer to worldly and sophisticated engineer Evan Priestley as "I", which is only natural as I am he. diff --git a/src/docs/user/flavortext/recommendations_on_branching.diviner b/src/docs/flavor/recommendations_on_branching.diviner similarity index 99% rename from src/docs/user/flavortext/recommendations_on_branching.diviner rename to src/docs/flavor/recommendations_on_branching.diviner index ea5088a786..38d196ad9b 100644 --- a/src/docs/user/flavortext/recommendations_on_branching.diviner +++ b/src/docs/flavor/recommendations_on_branching.diviner @@ -1,5 +1,5 @@ @title Recommendations on Branching -@group flavortext +@group review Project recommendations on how to organize branches. diff --git a/src/docs/user/flavortext/recommendations_on_revision_control.diviner b/src/docs/flavor/recommendations_on_revision_control.diviner similarity index 99% rename from src/docs/user/flavortext/recommendations_on_revision_control.diviner rename to src/docs/flavor/recommendations_on_revision_control.diviner index 66b7bfc9d9..0cb0eb5e6c 100644 --- a/src/docs/user/flavortext/recommendations_on_revision_control.diviner +++ b/src/docs/flavor/recommendations_on_revision_control.diviner @@ -1,5 +1,5 @@ @title Recommendations on Revision Control -@group flavortext +@group review Project recommendations on how to organize revision control. diff --git a/src/docs/user/flavortext/soon_static_resources.diviner b/src/docs/flavor/soon_static_resources.diviner similarity index 99% rename from src/docs/user/flavortext/soon_static_resources.diviner rename to src/docs/flavor/soon_static_resources.diviner index 1a663fea26..78820c5081 100644 --- a/src/docs/user/flavortext/soon_static_resources.diviner +++ b/src/docs/flavor/soon_static_resources.diviner @@ -1,5 +1,5 @@ @title Things You Should Do Soon: Static Resources -@group flavortext +@group sundry Over time, you'll write more JS and CSS and eventually need to put systems in place to manage it. diff --git a/src/docs/user/flavortext/things_you_should_do_now.diviner b/src/docs/flavor/things_you_should_do_now.diviner similarity index 99% rename from src/docs/user/flavortext/things_you_should_do_now.diviner rename to src/docs/flavor/things_you_should_do_now.diviner index d446c741c2..b4681bd0ca 100644 --- a/src/docs/user/flavortext/things_you_should_do_now.diviner +++ b/src/docs/flavor/things_you_should_do_now.diviner @@ -1,5 +1,5 @@ @title Things You Should Do Now -@group flavortext +@group sundry Describes things you should do now when building software, because the cost to do them increases over time and eventually becomes prohibitive or impossible. diff --git a/src/docs/user/flavortext/things_you_should_do_soon.diviner b/src/docs/flavor/things_you_should_do_soon.diviner similarity index 96% rename from src/docs/user/flavortext/things_you_should_do_soon.diviner rename to src/docs/flavor/things_you_should_do_soon.diviner index 3e6a019229..e1d960fd5e 100644 --- a/src/docs/user/flavortext/things_you_should_do_soon.diviner +++ b/src/docs/flavor/things_you_should_do_soon.diviner @@ -1,5 +1,5 @@ @title Things You Should Do Soon -@group flavortext +@group sundry Describes things you should start thinking about soon, because scaling will be easier if you put a plan in place. diff --git a/src/docs/user/flavortext/writing_reviewable_code.diviner b/src/docs/flavor/writing_reviewable_code.diviner similarity index 99% rename from src/docs/user/flavortext/writing_reviewable_code.diviner rename to src/docs/flavor/writing_reviewable_code.diviner index 687f7233a2..7e840b7b6d 100644 --- a/src/docs/user/flavortext/writing_reviewable_code.diviner +++ b/src/docs/flavor/writing_reviewable_code.diviner @@ -1,5 +1,5 @@ @title Writing Reviewable Code -@group flavortext +@group review Project recommendations on how to structure changes.