mirror of
https://we.phorge.it/source/phorge.git
synced 2024-11-10 08:52:39 +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:
parent
fb52eda3d9
commit
873a4721b8
31 changed files with 97 additions and 18 deletions
33
src/docs/book/contributor.book
Normal file
33
src/docs/book/contributor.book
Normal 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
42
src/docs/book/flavor.book
Normal 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"
|
||||
}
|
||||
}
|
||||
}
|
|
@ -16,7 +16,9 @@
|
|||
"(^scripts/)",
|
||||
"(^support/)",
|
||||
"(^resources/)",
|
||||
"(^src/docs/user/)"
|
||||
"(^src/docs/user/)",
|
||||
"(^src/docs/flavor/)",
|
||||
"(^src/docs/contributor/)"
|
||||
],
|
||||
"groups" : {
|
||||
"arcanist" : {
|
||||
|
|
|
@ -15,7 +15,9 @@
|
|||
"(^scripts/)",
|
||||
"(^support/)",
|
||||
"(^resources/)",
|
||||
"(^src/docs/tech/)"
|
||||
"(^src/docs/tech/)",
|
||||
"(^src/docs/flavor/)",
|
||||
"(^src/docs/contributor/)"
|
||||
],
|
||||
"groups" : {
|
||||
"intro" : {
|
||||
|
|
|
@ -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.
|
|
@ -1,5 +1,5 @@
|
|||
@title Internationalization
|
||||
@group contrib
|
||||
@group developer
|
||||
|
||||
What is required from developers to get Phabricator translatable.
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
@title Javascript Coding Standards
|
||||
@group contrib
|
||||
@group standards
|
||||
|
||||
This document describes Javascript coding standards for Phabricator and Javelin.
|
||||
|
|
@ -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).
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
@title About Flavor Text
|
||||
@group flavortext
|
||||
@group overview
|
||||
|
||||
Explains what's going on here.
|
||||
|
|
@ -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
|
|
@ -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.
|
|
@ -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.
|
|
@ -1,5 +1,5 @@
|
|||
@title Please Please Please
|
||||
@group flavortext
|
||||
@group sundry
|
||||
|
||||
Please read this document.
|
||||
|
|
@ -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.
|
|
@ -1,5 +1,5 @@
|
|||
@title Recommendations on Branching
|
||||
@group flavortext
|
||||
@group review
|
||||
|
||||
Project recommendations on how to organize branches.
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
@title Recommendations on Revision Control
|
||||
@group flavortext
|
||||
@group review
|
||||
|
||||
Project recommendations on how to organize revision control.
|
||||
|
|
@ -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.
|
|
@ -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.
|
|
@ -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.
|
|
@ -1,5 +1,5 @@
|
|||
@title Writing Reviewable Code
|
||||
@group flavortext
|
||||
@group review
|
||||
|
||||
Project recommendations on how to structure changes.
|
||||
|
Loading…
Reference in a new issue