Skip to content

Commit 536b086

Browse files
author
epriestley
committed
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
1 parent a96582c commit 536b086

File tree

83 files changed

+20
-15
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+20
-15
lines changed

src/docs/book/phabricator.book

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@
66
"uri.source" :
77
"https://secure.phabricator.com/diffusion/P/browse/master/%f$%l",
88
"rules" : {
9-
"(\\.php$)" : "DivinerPHPAtomizer"
9+
"(\\.php$)" : "DivinerPHPAtomizer",
10+
"(\\.diviner$)" : "DivinerArticleAtomizer"
1011
},
1112
"exclude" : [
1213
"(^externals/)",
1314
"(^scripts/)",
1415
"(^support/)",
15-
"(^resources/)"
16+
"(^resources/)",
17+
"(^src/docs/user/)"
1618
],
1719
"groups" : {
1820
}

src/docs/book/user.book

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,11 @@
1010
},
1111
"exclude" : [
1212
"(^externals/)",
13+
"(^webroot/rsrc/externals/)",
1314
"(^scripts/)",
14-
"(^support/)"
15+
"(^support/)",
16+
"(^resources/)",
17+
"(^src/docs/tech/)"
1518
],
1619
"groups" : {
1720
"intro" : {
File renamed without changes.
File renamed without changes.

src/docs/technical/conduit.diviner renamed to src/docs/tech/conduit.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,4 @@ A log of connections and calls is stored by
5454
Conduit provides a token-based handshake mechanism used by
5555
##arc install-certificate## at ##/conduit/token/##, implemented by
5656
@{class:PhabricatorConduitTokenController} which stores generated tokens using
57-
@{class:PhabricatorConduitCertificateToken}.
57+
@{class:PhabricatorConduitCertificateToken}.

src/docs/technical/files.diviner renamed to src/docs/tech/files.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ order to make files actually get written to it, you also need to extend
3636
@{class:PhabricatorFileStorageEngineSelector}, provide an implementation which
3737
selects your storage engine for whatever files you want to store there, and then
3838
configure Phabricator to use your selector by setting
39-
##storage.engine-selector##.
39+
##storage.engine-selector##.

src/docs/configuration/configuring_file_storage.diviner renamed to src/docs/user/configuration/configuring_file_storage.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,4 +102,4 @@ Continue by:
102102

103103
- configuring file size upload limits with
104104
@{article:Configuring File Upload Limits}; or
105-
- returning to the @{article:Configuration Guide}.
105+
- returning to the @{article:Configuration Guide}.
File renamed without changes.

src/docs/flavortext/writing_reviewable_code.diviner renamed to src/docs/user/flavortext/writing_reviewable_code.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,4 +160,4 @@ Continue by:
160160
- reading recommendations on structuring revision control with
161161
@{article:Recommendations on Revision Control}; or
162162
- reading recommendations on structuring branches with
163-
@{article:Recommendations on Branching}.
163+
@{article:Recommendations on Branching}.
File renamed without changes.

src/docs/userguide/arcanist_coverage.diviner renamed to src/docs/user/userguide/arcanist_coverage.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,4 @@ might look like this:
6666
You may also want to filter coverage information to the paths passed to the
6767
unit test engine. See @{class@arcanist:ArcanistPhutilTestCase} and
6868
@{class@arcanist:PhutilUnitTestEngine} for an example of coverage integration
69-
in PHP using Xdebug.
69+
in PHP using Xdebug.

src/docs/userguide/arcanist_extending_lint.diviner renamed to src/docs/user/userguide/arcanist_extending_lint.diviner

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,14 @@ widths on different languages:
7070

7171
$linters = array();
7272

73-
// Warn on JS/CSS lines longer than 80 columns.
73+
// Warn on JS/CSS lines longer than 80 columns.
7474
$linters['TextLinter80Col'] = id(new ArcanistTextLinter())
75-
->setPaths(preg_grep('/\.(js|css)$/', $paths));
75+
->setPaths(preg_grep('/\.(js|css)$/', $paths));
7676

77-
// Warn on Java lines longer than 120 columns.
77+
// Warn on Java lines longer than 120 columns.
7878
$linters['TextLinter120Col'] = id(new ArcanistTextLinter())
79-
->setMaxLineLength(120)
80-
->setPaths(preg_grep('/\.(java)$/', $paths));
79+
->setMaxLineLength(120)
80+
->setPaths(preg_grep('/\.(java)$/', $paths));
8181

8282
// ...
8383

src/docs/userguide/drydock.diviner renamed to src/docs/user/userguide/drydock.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ Configuring Drydock for machine resource management.
55

66
= Overview =
77

8-
NOTE: Drydock is extremely new and not very useful yet.
8+
NOTE: Drydock is extremely new and not very useful yet.

src/docs/userguide/external_editor.diviner renamed to src/docs/user/userguide/external_editor.diviner

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ Then set your "Editor Link" to:
4848
General instructions for configuring some other editors and environments can be
4949
found here:
5050

51-
http://wiki.nette.org/en/howto-editor-link
51+
http://wiki.nette.org/en/howto-editor-link

0 commit comments

Comments
 (0)