1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-12-24 22:40:55 +01:00

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
This commit is contained in:
epriestley 2014-03-05 13:00:24 -08:00
parent fb52eda3d9
commit 873a4721b8
31 changed files with 97 additions and 18 deletions

View file

@ -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"
}
}
}

42
src/docs/book/flavor.book Normal file
View file

@ -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"
}
}
}

View file

@ -16,7 +16,9 @@
"(^scripts/)", "(^scripts/)",
"(^support/)", "(^support/)",
"(^resources/)", "(^resources/)",
"(^src/docs/user/)" "(^src/docs/user/)",
"(^src/docs/flavor/)",
"(^src/docs/contributor/)"
], ],
"groups" : { "groups" : {
"arcanist" : { "arcanist" : {

View file

@ -15,7 +15,9 @@
"(^scripts/)", "(^scripts/)",
"(^support/)", "(^support/)",
"(^resources/)", "(^resources/)",
"(^src/docs/tech/)" "(^src/docs/tech/)",
"(^src/docs/flavor/)",
"(^src/docs/contributor/)"
], ],
"groups" : { "groups" : {
"intro" : { "intro" : {

View file

@ -1,5 +1,5 @@
@title General Coding Standards @title General Coding Standards
@group contrib @group standards
This document is a general coding standard for contributing to Phabricator, This document is a general coding standard for contributing to Phabricator,
Arcanist, libphutil and Diviner. Arcanist, libphutil and Diviner.

View file

@ -1,5 +1,5 @@
@title Internationalization @title Internationalization
@group contrib @group developer
What is required from developers to get Phabricator translatable. What is required from developers to get Phabricator translatable.

View file

@ -1,5 +1,5 @@
@title Javascript Coding Standards @title Javascript Coding Standards
@group contrib @group standards
This document describes Javascript coding standards for Phabricator and Javelin. This document describes Javascript coding standards for Phabricator and Javelin.

View file

@ -1,5 +1,5 @@
@title PHP Coding Standards @title PHP Coding Standards
@group contrib @group standards
This document describes PHP coding standards for Phabricator and related projects (like Arcanist and libphutil). This document describes PHP coding standards for Phabricator and related projects (like Arcanist and libphutil).

View file

@ -1,5 +1,5 @@
@title About Flavor Text @title About Flavor Text
@group flavortext @group overview
Explains what's going on here. Explains what's going on here.

View file

@ -1,5 +1,5 @@
@title Javascript Object and Array @title Javascript Object and Array
@group flavortext @group javascript
This document describes the behaviors of Object and Array in Javascript, and This document describes the behaviors of Object and Array in Javascript, and
a specific approach to their use which produces basically reasonable language a specific approach to their use which produces basically reasonable language

View file

@ -1,5 +1,5 @@
@title Javascript Pitfalls @title Javascript Pitfalls
@group flavortext @group javascript
This document discusses pitfalls and flaws in the Javascript language, and how This document discusses pitfalls and flaws in the Javascript language, and how
to avoid, work around, or at least understand them. to avoid, work around, or at least understand them.

View file

@ -1,5 +1,5 @@
@title PHP Pitfalls @title PHP Pitfalls
@group flavortext @group php
This document discusses difficult traps and pitfalls in PHP, and how to avoid, This document discusses difficult traps and pitfalls in PHP, and how to avoid,
work around, or at least understand them. work around, or at least understand them.

View file

@ -1,5 +1,5 @@
@title Please Please Please @title Please Please Please
@group flavortext @group sundry
Please read this document. Please read this document.

View file

@ -1,5 +1,5 @@
@title Phabricator Project History @title Phabricator Project History
@group flavortext @group lore
A riveting tale of adventure. In this document, I refer to worldly and 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. sophisticated engineer Evan Priestley as "I", which is only natural as I am he.

View file

@ -1,5 +1,5 @@
@title Recommendations on Branching @title Recommendations on Branching
@group flavortext @group review
Project recommendations on how to organize branches. Project recommendations on how to organize branches.

View file

@ -1,5 +1,5 @@
@title Recommendations on Revision Control @title Recommendations on Revision Control
@group flavortext @group review
Project recommendations on how to organize revision control. Project recommendations on how to organize revision control.

View file

@ -1,5 +1,5 @@
@title Things You Should Do Soon: Static Resources @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 Over time, you'll write more JS and CSS and eventually need to put systems in
place to manage it. place to manage it.

View file

@ -1,5 +1,5 @@
@title Things You Should Do Now @title Things You Should Do Now
@group flavortext @group sundry
Describes things you should do now when building software, because the cost to Describes things you should do now when building software, because the cost to
do them increases over time and eventually becomes prohibitive or impossible. do them increases over time and eventually becomes prohibitive or impossible.

View file

@ -1,5 +1,5 @@
@title Things You Should Do Soon @title Things You Should Do Soon
@group flavortext @group sundry
Describes things you should start thinking about soon, because scaling will Describes things you should start thinking about soon, because scaling will
be easier if you put a plan in place. be easier if you put a plan in place.

View file

@ -1,5 +1,5 @@
@title Writing Reviewable Code @title Writing Reviewable Code
@group flavortext @group review
Project recommendations on how to structure changes. Project recommendations on how to structure changes.