@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.) hq.recaptime.dev/wiki/Phorge
phorge phabricator
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

Divide Phabricator documentation into four books

Summary:
Ref T988. Divides documentation into four books:

- User: Install, configure and use Phabricator.
- Contrib: Develop and contribute to Phabricator.
- Flavor: Worldly advice.
- Generated: Generated technical documentation.

Test Plan: Generated the books and got sensible results. See screenshots.

Reviewers: chad, btrahan

Reviewed By: btrahan

CC: chad, aran

Maniphest Tasks: T988

Differential Revision: https://secure.phabricator.com/D8414

+97 -18
+33
src/docs/book/contributor.book
··· 1 + { 2 + "name" : "phabcontrib", 3 + "title" : "Phabricator Contributor Documentation", 4 + "short" : "Phabricator Contributor Docs", 5 + "preface" : "Information for Phabricator contributors.", 6 + "root" : "../../../", 7 + "uri.source" : 8 + "https://secure.phabricator.com/diffusion/P/browse/master/%f$%l", 9 + "rules" : { 10 + "(\\.diviner$)" : "DivinerArticleAtomizer" 11 + }, 12 + "exclude" : [ 13 + "(^externals/)", 14 + "(^webroot/rsrc/externals/)", 15 + "(^scripts/)", 16 + "(^support/)", 17 + "(^resources/)", 18 + "(^src/docs/user/)", 19 + "(^src/docs/tech/)", 20 + "(^src/docs/flavor/)" 21 + ], 22 + "groups" : { 23 + "contrib" : { 24 + "name" : "Contributor Overview" 25 + }, 26 + "standards" : { 27 + "name" : "Coding Standards" 28 + }, 29 + "developer" : { 30 + "name" : "Developer Guides" 31 + } 32 + } 33 + }
+42
src/docs/book/flavor.book
··· 1 + { 2 + "name" : "phabflavor", 3 + "title" : "Phabricator Flavor Text", 4 + "short" : "Flavor Text", 5 + "preface" : "Recommendations, lore, and dark rituals.", 6 + "root" : "../../../", 7 + "uri.source" : 8 + "https://secure.phabricator.com/diffusion/P/browse/master/%f$%l", 9 + "rules" : { 10 + "(\\.diviner$)" : "DivinerArticleAtomizer" 11 + }, 12 + "exclude" : [ 13 + "(^externals/)", 14 + "(^webroot/rsrc/externals/)", 15 + "(^scripts/)", 16 + "(^support/)", 17 + "(^resources/)", 18 + "(^src/docs/user/)", 19 + "(^src/docs/tech/)", 20 + "(^src/docs/contributor/)" 21 + ], 22 + "groups" : { 23 + "overview" : { 24 + "name" : "Overview" 25 + }, 26 + "review" : { 27 + "name" : "Revision Control and Code Review" 28 + }, 29 + "sundry" : { 30 + "name" : "Sundries" 31 + }, 32 + "lore" : { 33 + "name" : "Phabricator Lore" 34 + }, 35 + "php" : { 36 + "name" : "PHP" 37 + }, 38 + "javascript" : { 39 + "name" : "Javascript" 40 + } 41 + } 42 + }
+3 -1
src/docs/book/phabricator.book
··· 16 16 "(^scripts/)", 17 17 "(^support/)", 18 18 "(^resources/)", 19 - "(^src/docs/user/)" 19 + "(^src/docs/user/)", 20 + "(^src/docs/flavor/)", 21 + "(^src/docs/contributor/)" 20 22 ], 21 23 "groups" : { 22 24 "arcanist" : {
+3 -1
src/docs/book/user.book
··· 15 15 "(^scripts/)", 16 16 "(^support/)", 17 17 "(^resources/)", 18 - "(^src/docs/tech/)" 18 + "(^src/docs/tech/)", 19 + "(^src/docs/flavor/)", 20 + "(^src/docs/contributor/)" 19 21 ], 20 22 "groups" : { 21 23 "intro" : {
src/docs/user/contributing/contrib_intro.diviner src/docs/contributor/contrib_intro.diviner
+1 -1
src/docs/user/contributing/general_coding_standards.diviner src/docs/contributor/general_coding_standards.diviner
··· 1 1 @title General Coding Standards 2 - @group contrib 2 + @group standards 3 3 4 4 This document is a general coding standard for contributing to Phabricator, 5 5 Arcanist, libphutil and Diviner.
+1 -1
src/docs/user/contributing/internationalization.diviner src/docs/contributor/internationalization.diviner
··· 1 1 @title Internationalization 2 - @group contrib 2 + @group developer 3 3 4 4 What is required from developers to get Phabricator translatable. 5 5
+1 -1
src/docs/user/contributing/javascript_coding_standards.diviner src/docs/contributor/javascript_coding_standards.diviner
··· 1 1 @title Javascript Coding Standards 2 - @group contrib 2 + @group standards 3 3 4 4 This document describes Javascript coding standards for Phabricator and Javelin. 5 5
+1 -1
src/docs/user/contributing/php_coding_standards.diviner src/docs/contributor/php_coding_standards.diviner
··· 1 1 @title PHP Coding Standards 2 - @group contrib 2 + @group standards 3 3 4 4 This document describes PHP coding standards for Phabricator and related projects (like Arcanist and libphutil). 5 5
src/docs/user/developer/adding_new_css_and_js.diviner src/docs/contributor/adding_new_css_and_js.diviner
src/docs/user/developer/darkconsole.diviner src/docs/contributor/darkconsole.diviner
src/docs/user/developer/database.diviner src/docs/contributor/database.diviner
src/docs/user/developer/n_plus_one.diviner src/docs/contributor/n_plus_one.diviner
src/docs/user/developer/phabricator_code_layout.diviner src/docs/contributor/phabricator_code_layout.diviner
src/docs/user/developer/rendering_html.diviner src/docs/contributor/rendering_html.diviner
src/docs/user/developer/running_builtin_php_webserver.diviner src/docs/contributor/running_builtin_php_webserver.diviner
src/docs/user/developer/unit_tests.diviner src/docs/contributor/unit_tests.diviner
src/docs/user/developer/using_edges.diviner src/docs/contributor/using_edges.diviner
src/docs/user/developer/using_oauthserver.diviner src/docs/contributor/using_oauthserver.diviner
+1 -1
src/docs/user/flavortext/about_flavor_text.diviner src/docs/flavor/about_flavor_text.diviner
··· 1 1 @title About Flavor Text 2 - @group flavortext 2 + @group overview 3 3 4 4 Explains what's going on here. 5 5
+1 -1
src/docs/user/flavortext/javascript_object_array.diviner src/docs/flavor/javascript_object_array.diviner
··· 1 1 @title Javascript Object and Array 2 - @group flavortext 2 + @group javascript 3 3 4 4 This document describes the behaviors of Object and Array in Javascript, and 5 5 a specific approach to their use which produces basically reasonable language
+1 -1
src/docs/user/flavortext/javascript_pitfalls.diviner src/docs/flavor/javascript_pitfalls.diviner
··· 1 1 @title Javascript Pitfalls 2 - @group flavortext 2 + @group javascript 3 3 4 4 This document discusses pitfalls and flaws in the Javascript language, and how 5 5 to avoid, work around, or at least understand them.
+1 -1
src/docs/user/flavortext/php_pitfalls.diviner src/docs/flavor/php_pitfalls.diviner
··· 1 1 @title PHP Pitfalls 2 - @group flavortext 2 + @group php 3 3 4 4 This document discusses difficult traps and pitfalls in PHP, and how to avoid, 5 5 work around, or at least understand them.
+1 -1
src/docs/user/flavortext/please_please_please.diviner src/docs/flavor/please_please_please.diviner
··· 1 1 @title Please Please Please 2 - @group flavortext 2 + @group sundry 3 3 4 4 Please read this document. 5 5
+1 -1
src/docs/user/flavortext/project_history.diviner src/docs/flavor/project_history.diviner
··· 1 1 @title Phabricator Project History 2 - @group flavortext 2 + @group lore 3 3 4 4 A riveting tale of adventure. In this document, I refer to worldly and 5 5 sophisticated engineer Evan Priestley as "I", which is only natural as I am he.
+1 -1
src/docs/user/flavortext/recommendations_on_branching.diviner src/docs/flavor/recommendations_on_branching.diviner
··· 1 1 @title Recommendations on Branching 2 - @group flavortext 2 + @group review 3 3 4 4 Project recommendations on how to organize branches. 5 5
+1 -1
src/docs/user/flavortext/recommendations_on_revision_control.diviner src/docs/flavor/recommendations_on_revision_control.diviner
··· 1 1 @title Recommendations on Revision Control 2 - @group flavortext 2 + @group review 3 3 4 4 Project recommendations on how to organize revision control. 5 5
+1 -1
src/docs/user/flavortext/soon_static_resources.diviner src/docs/flavor/soon_static_resources.diviner
··· 1 1 @title Things You Should Do Soon: Static Resources 2 - @group flavortext 2 + @group sundry 3 3 4 4 Over time, you'll write more JS and CSS and eventually need to put systems in 5 5 place to manage it.
+1 -1
src/docs/user/flavortext/things_you_should_do_now.diviner src/docs/flavor/things_you_should_do_now.diviner
··· 1 1 @title Things You Should Do Now 2 - @group flavortext 2 + @group sundry 3 3 4 4 Describes things you should do now when building software, because the cost to 5 5 do them increases over time and eventually becomes prohibitive or impossible.
+1 -1
src/docs/user/flavortext/things_you_should_do_soon.diviner src/docs/flavor/things_you_should_do_soon.diviner
··· 1 1 @title Things You Should Do Soon 2 - @group flavortext 2 + @group sundry 3 3 4 4 Describes things you should start thinking about soon, because scaling will 5 5 be easier if you put a plan in place.
+1 -1
src/docs/user/flavortext/writing_reviewable_code.diviner src/docs/flavor/writing_reviewable_code.diviner
··· 1 1 @title Writing Reviewable Code 2 - @group flavortext 2 + @group review 3 3 4 4 Project recommendations on how to structure changes. 5 5