revi-archive/phorge-phorge
1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-11-11 01:12:41 +01:00
Code Issues Releases Wiki Activity
phorge-phorge/src/docs/book/phabricator.book

274 lines
6.8 KiB
Text
Raw Normal View History

Generate PHP function documentation in Diviner Summary: Ref T988. Various improvements: - Generate function documentation, mostly correctly. - Raise some warnings about bad documentation. - Allow `.book` files to exclude paths from generation. - Add a book for technical docs. - Exclude "ghosts" from common queries (atoms which used to exist, but no longer do, but which we want to keep the PHIDs around for in case they come back later). This is a bit rough still, but puts us much closer to being able to get rid of the old Diviner. Test Plan: See screenshots. Reviewers: btrahan, chad Reviewed By: btrahan CC: aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6812
2013-08-27 12:14:00 +02:00
{
"name" : "phabdev",
"title" : "Phabricator Technical Documentation",
"short" : "Phabricator Tech Docs",
Allow Diviner books to have a "preface" section Summary: Ref T988. This is primarily intended to let us add the "HEY! THIS ISN'T USER DOCUMENTATION" notices to the arcanist and libphutil technical docs. Test Plan: Added some prefaces, generated docs, looked at them. Reviewers: chad, btrahan Reviewed By: btrahan CC: aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D8410
2014-03-05 21:08:01 +01:00
"preface" : "Technical documentation intended for Phabricator developers.",
Generate PHP function documentation in Diviner Summary: Ref T988. Various improvements: - Generate function documentation, mostly correctly. - Raise some warnings about bad documentation. - Allow `.book` files to exclude paths from generation. - Add a book for technical docs. - Exclude "ghosts" from common queries (atoms which used to exist, but no longer do, but which we want to keep the PHIDs around for in case they come back later). This is a bit rough still, but puts us much closer to being able to get rid of the old Diviner. Test Plan: See screenshots. Reviewers: btrahan, chad Reviewed By: btrahan CC: aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6812
2013-08-27 12:14:00 +02:00
"root" : "../../../",
Add source links and a little documentation about Diviner Summary: Ref T988. Links up the "Declared:" property to point at a repository browser, if one exists. Test Plan: Viewed a class document, saw a link, clicked it, got the definition. Reviewers: btrahan Reviewed By: btrahan CC: aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6820
2013-08-28 18:54:54 +02:00
"uri.source" :
"https://secure.phabricator.com/diffusion/P/browse/master/%f$%l",
Generate PHP function documentation in Diviner Summary: Ref T988. Various improvements: - Generate function documentation, mostly correctly. - Raise some warnings about bad documentation. - Allow `.book` files to exclude paths from generation. - Add a book for technical docs. - Exclude "ghosts" from common queries (atoms which used to exist, but no longer do, but which we want to keep the PHIDs around for in case they come back later). This is a bit rough still, but puts us much closer to being able to get rid of the old Diviner. Test Plan: See screenshots. Reviewers: btrahan, chad Reviewed By: btrahan CC: aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6812
2013-08-27 12:14:00 +02:00
"rules" : {
Reorganize Diviner articles into `user/` and `tech/` Summary: Ref T988. I'm splitting the Phabricator documentation into two separate documentation books, one less technical and one more technical. Move all the `.diviner` article files around into `src/docs/user/` or `src/docs/tech/`, accordingly. The only actual changes here are a couple of config changes in the `.book` files. Test Plan: Regenerated user and technical documentation and saw stuff in the right places. Reviewers: btrahan Reviewed By: btrahan CC: chad, aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6822
2013-08-28 18:57:00 +02:00
"(\\.php$)" : "DivinerPHPAtomizer",
"(\\.diviner$)" : "DivinerArticleAtomizer"
Generate PHP function documentation in Diviner Summary: Ref T988. Various improvements: - Generate function documentation, mostly correctly. - Raise some warnings about bad documentation. - Allow `.book` files to exclude paths from generation. - Add a book for technical docs. - Exclude "ghosts" from common queries (atoms which used to exist, but no longer do, but which we want to keep the PHIDs around for in case they come back later). This is a bit rough still, but puts us much closer to being able to get rid of the old Diviner. Test Plan: See screenshots. Reviewers: btrahan, chad Reviewed By: btrahan CC: aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6812
2013-08-27 12:14:00 +02:00
},
"exclude" : [
"(^externals/)",
Clean up some more Diviner stuff Summary: Ref T988. - Render "Implements:" as tags, too. - Minor CSS tweak to tags in property lists. - Add a bunch of group patterns to the Phabricator book. - Fix some stuff with how hashes are computed and cached. - Minor tweak to reuse the Diviner engine for slightly improved performance. Test Plan: Regenerated and looked at documentation. Reviewers: chad Reviewed By: chad CC: aran Maniphest Tasks: T3811, T988 Differential Revision: https://secure.phabricator.com/D6912
2013-09-08 18:16:55 +02:00
"(^webroot/rsrc/externals/)",
Generate PHP function documentation in Diviner Summary: Ref T988. Various improvements: - Generate function documentation, mostly correctly. - Raise some warnings about bad documentation. - Allow `.book` files to exclude paths from generation. - Add a book for technical docs. - Exclude "ghosts" from common queries (atoms which used to exist, but no longer do, but which we want to keep the PHIDs around for in case they come back later). This is a bit rough still, but puts us much closer to being able to get rid of the old Diviner. Test Plan: See screenshots. Reviewers: btrahan, chad Reviewed By: btrahan CC: aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6812
2013-08-27 12:14:00 +02:00
"(^scripts/)",
"(^support/)",
Reorganize Diviner articles into `user/` and `tech/` Summary: Ref T988. I'm splitting the Phabricator documentation into two separate documentation books, one less technical and one more technical. Move all the `.diviner` article files around into `src/docs/user/` or `src/docs/tech/`, accordingly. The only actual changes here are a couple of config changes in the `.book` files. Test Plan: Regenerated user and technical documentation and saw stuff in the right places. Reviewers: btrahan Reviewed By: btrahan CC: chad, aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6822
2013-08-28 18:57:00 +02:00
"(^resources/)",
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
2014-03-05 22:00:24 +01:00
"(^src/docs/user/)",
"(^src/docs/flavor/)",
"(^src/docs/contributor/)"
Generate PHP function documentation in Diviner Summary: Ref T988. Various improvements: - Generate function documentation, mostly correctly. - Raise some warnings about bad documentation. - Allow `.book` files to exclude paths from generation. - Add a book for technical docs. - Exclude "ghosts" from common queries (atoms which used to exist, but no longer do, but which we want to keep the PHIDs around for in case they come back later). This is a bit rough still, but puts us much closer to being able to get rid of the old Diviner. Test Plan: See screenshots. Reviewers: btrahan, chad Reviewed By: btrahan CC: aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6812
2013-08-27 12:14:00 +02:00
],
"groups" : {
Clean up some more Diviner stuff Summary: Ref T988. - Render "Implements:" as tags, too. - Minor CSS tweak to tags in property lists. - Add a bunch of group patterns to the Phabricator book. - Fix some stuff with how hashes are computed and cached. - Minor tweak to reuse the Diviner engine for slightly improved performance. Test Plan: Regenerated and looked at documentation. Reviewers: chad Reviewed By: chad CC: aran Maniphest Tasks: T3811, T988 Differential Revision: https://secure.phabricator.com/D6912
2013-09-08 18:16:55 +02:00
"arcanist" : {
"name" : "Arcanist Integration",
"include" : "(^src/applications/arcanist/)"
},
"audit" : {
"name" : "Audit",
"include" : "(^src/applications/audit/)"
},
"auth" : {
"name" : "Auth",
"include" : "(^src/applications/auth/)"
},
"baseapp" : {
"name" : "Application Basics",
"include" : "(^src/applications/base/)"
},
"cache" : {
"name" : "Cache",
"include" : "(^src/applications/cache/)"
},
"calendar" : {
"name" : "Calendar",
"include" : "(^src/applications/calendar/)"
},
"chatlog" : {
"name" : "Chatlog",
"include" : "(^src/applications/chatlog/)"
},
"conduit" : {
"name" : "Conduit",
"include" : "(^src/applications/conduit/)"
},
"config" : {
"name" : "Config",
"include" : "(^src/applications/config/)"
},
"conpherence" : {
"name" : "Conpherence",
"include" : "(^src/applications/conpherence/)"
},
"countdown" : {
"name" : "Countdown",
"include" : "(^src/applications/countdown/)"
},
"daemon" : {
"name" : "Daemons",
"include" : "(^src/applications/daemon/)"
},
"differential" : {
"name" : "Differential",
"include" : "(^src/applications/differential/)"
},
"diffusion" : {
"name" : "Diffusion",
"include" : "(^src/applications/diffusion/)"
},
"directory" : {
"name" : "Directory",
"include" : "(^src/applications/directory/)"
},
"diviner" : {
"name" : "Diviner",
"include" : "(^src/applications/diviner/)"
},
"doorkeeper" : {
"name" : "Doorkeeper",
"include" : "(^src/applications/doorkeeper/)"
},
"draft" : {
"name" : "Draft",
"include" : "(^src/applications/draft/)"
},
"drydock" : {
"name" : "Drydock",
"include" : "(^src/applications/drydock/)"
},
"fact" : {
"name" : "Fact",
"include" : "(^src/applications/fact/)"
},
"feed" : {
"name" : "Feed",
"include" : "(^src/applications/feed/)"
},
"files" : {
"name" : "Files",
"include" : "(^src/applications/files/)"
},
"flag" : {
"name" : "Flags",
"include" : "(^src/applications/flag/)"
},
"harbormaster" : {
"name" : "Harbormaster",
"include" : "(^src/applications/harbormaster/)"
},
"help" : {
"name" : "Help",
"include" : "(^src/applications/help/)"
},
"herald" : {
"name" : "Herald",
"include" : "(^src/applications/herald/)"
},
"legalpad" : {
"name" : "Legalpad",
"include" : "(^src/applications/legalpad/)"
},
"lipsum" : {
"name" : "Lipsum",
"include" : "(^src/applications/lipsum/)"
},
"macro" : {
"name" : "Macro",
"include" : "(^src/applications/macro/)"
},
"mailinglists" : {
"name" : "Mailing Lists",
"include" : "(^src/applications/mailinglists/)"
},
"maniphest" : {
"name" : "Maniphest",
"include" : "(^src/applications/maniphest/)"
},
"meta" : {
"name" : "Meta",
"include" : "(^src/applications/meta/)"
},
"metamta" : {
"name" : "MetaMTA",
"include" : "(^src/applications/metamta/)"
},
"notification" : {
"name" : "Notifications",
"include" : "(^src/applications/notification/)"
},
"oauthserver" : {
"name" : "OAuth Server",
"include" : "(^src/applications/oauthserver/)"
},
"owners" : {
"name" : "Owners",
"include" : "(^src/applications/owners/)"
},
Allow Diviner groups to be configured in `.book` files Summary: Ref T988. Currently, every class/function needs to be annotated with `@group`, but 99% of this data can be inferred from file structure, at least in this project. Allow group specifications like: "paste" : { "name" : "Paste", "include" : "(^src/applications/paste/)" } ..to automatically put everything defined there in the "paste" group. A list of regexps is also supported. Depends on D6855. Test Plan: Regenerated documentation with `bin/diviner generate --book src/docs/book/phabricator.book --clean`, observed all Paste stuff go in the paste group. Reviewers: btrahan Reviewed By: btrahan CC: aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6856
2013-09-02 20:33:02 +02:00
"paste" : {
"name" : "Paste",
"include" : "(^src/applications/paste/)"
Clean up some more Diviner stuff Summary: Ref T988. - Render "Implements:" as tags, too. - Minor CSS tweak to tags in property lists. - Add a bunch of group patterns to the Phabricator book. - Fix some stuff with how hashes are computed and cached. - Minor tweak to reuse the Diviner engine for slightly improved performance. Test Plan: Regenerated and looked at documentation. Reviewers: chad Reviewed By: chad CC: aran Maniphest Tasks: T3811, T988 Differential Revision: https://secure.phabricator.com/D6912
2013-09-08 18:16:55 +02:00
},
"people" : {
"name" : "People",
"include" : "(^src/applications/people/)"
},
"phame" : {
"name" : "Phame",
"include" : "(^src/applications/phame/)"
},
"phid" : {
"name" : "PHIDs",
"include" : "(^src/applications/phid/)"
},
"phlux" : {
"name" : "Phlux",
"include" : "(^src/applications/phlux/)"
},
"pholio" : {
"name" : "Pholio",
"include" : "(^src/applications/pholio/)"
},
"phortune" : {
"name" : "Phortune",
"include" : "(^src/applications/phortune/)"
},
"phpast" : {
"name" : "PHPAST",
"include" : "(^src/applications/phpast/)"
},
"phrequent" : {
"name" : "Phrequent",
"include" : "(^src/applications/phrequent/)"
},
"phriction" : {
"name" : "Phriction",
"include" : "(^src/applications/phriction/)"
},
"policy" : {
"name" : "Policy",
"include" : "(^src/applications/policy/)"
},
"ponder" : {
"name" : "Ponder",
"include" : "(^src/applications/ponder/)"
},
"project" : {
"name" : "Projects",
"include" : "(^src/applications/project/)"
},
"releeph" : {
"name" : "Releeph",
"include" : "(^src/applications/releeph/)"
},
"remarkup" : {
"name" : "Remarkup",
"include" : "(^src/applications/remarkup/)"
},
"repository" : {
"name" : "Repositories",
"include" : "(^src/applications/repository/)"
},
"search" : {
"name" : "Search",
"include" : "(^src/applications/search/)"
},
"settings" : {
"name" : "Settings",
"include" : "(^src/applications/settings/)"
},
"slowvote" : {
"name" : "Slowvote",
"include" : "(^src/applications/slowvote/)"
},
"subscriptions" : {
"name" : "Subscriptions",
"include" : "(^src/applications/subscriptions/)"
},
"system" : {
"name" : "System",
"include" : "(^src/applications/system/)"
},
"tokens" : {
"name" : "Tokens",
"include" : "(^src/applications/tokens/)"
},
"transactions" : {
"name" : "Transactions",
"include" : "(^src/applications/transactions/)"
},
"typeahead" : {
"name" : "Typeahead",
"include" : "(^src/applications/typeahead/)"
},
"uiexample" : {
"name" : "UI Examples",
"include" : "(^src/applications/uiexample/)"
},
"xhprof" : {
"name" : "XHProf",
"include" : "(^src/applications/xhprof/)"
Allow Diviner groups to be configured in `.book` files Summary: Ref T988. Currently, every class/function needs to be annotated with `@group`, but 99% of this data can be inferred from file structure, at least in this project. Allow group specifications like: "paste" : { "name" : "Paste", "include" : "(^src/applications/paste/)" } ..to automatically put everything defined there in the "paste" group. A list of regexps is also supported. Depends on D6855. Test Plan: Regenerated documentation with `bin/diviner generate --book src/docs/book/phabricator.book --clean`, observed all Paste stuff go in the paste group. Reviewers: btrahan Reviewed By: btrahan CC: aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6856
2013-09-02 20:33:02 +02:00
}
Generate PHP function documentation in Diviner Summary: Ref T988. Various improvements: - Generate function documentation, mostly correctly. - Raise some warnings about bad documentation. - Allow `.book` files to exclude paths from generation. - Add a book for technical docs. - Exclude "ghosts" from common queries (atoms which used to exist, but no longer do, but which we want to keep the PHIDs around for in case they come back later). This is a bit rough still, but puts us much closer to being able to get rid of the old Diviner. Test Plan: See screenshots. Reviewers: btrahan, chad Reviewed By: btrahan CC: aran Maniphest Tasks: T988 Differential Revision: https://secure.phabricator.com/D6812
2013-08-27 12:14:00 +02:00
}
}
Copy permalink