Here we'll track the Rebranding effort.
The process we settled for is this:
1. Pick an app from the list below. Put your name next to it.
2. Make a revision to this instance (rP), updating the strings in this app (See below for Guidelines on that)
3. Once we're happy with it, we'll copy the diff over to `secure.phabricator.com` for inclusion in Phabricator. If you don't have an account there, someone with an account (e.g. @avivey, @speck) will copy it.
3. The diff //will not be landed// directly in Phorge - we'll pick it up from the upstream after its landed there.
(We haven't actually discussed with with epriestley yet, but we're hopeful). - https://secure.phabricator.com/T13658#256501
==== Rebranding Guidelines
1. For each application, review all user-facing text and rephrase it to be general purpose text, such as referring to "Phabricator" as "the installation", "this installation", or "the platform". See examples in https://secure.phabricator.com/D21712com/D21712.
2. For any user-facing documentation which requires referencing "Phabricator", there is a new remarkup interpreter which resolves the `{{{ strings.platform.name }}}` macro to the brand name (update: this exists in the Phabricator upstream which is not yet merged into Phorge).
3. Anything which refers to `phabricator` as a path on disk or a class name, which is not user-facing, can remain for now and be addressed in a different change. This helps to limit to scope of necessary changes for the branding effort. Note that many of the descriptive text in in the `config` application will refer to running scripts on the server `/phabricator/bin/` path, which will need updated to reference a variable for the repo name.
=== Coding Guidelines
Since all changes are going to be submitted to the upstream prior to landing here in Phorge it would be easiest if changes were made to a clone of Phabricator and not a clone of Phorge.
2. For any user-facing documentation which requires referencing "Phabricator", there is a new remarkup interpreter which resolves the `{{{ strings.platform.name }}}` macro to the brand name (update: might not actually exist yet?.To help locate user-visible text grep for the following regular expressions
- `'.*Phabricator`
- `".*Phabricator`
3.===== Formatting
- Phabricator maintains PHP formatting which keeps lines 80 characters or less, using indentation of 2 spaces per indent. For multiple lines attempt to maximize the number of words on each line (and necessary formatting, see next point) to be less than or equal to 80 characters.
- When splitting long text across multiple lines use the `.` concatenation, and split the lines such that spaces between words and the `.` concatenation are at the end of the line
- Prefer to align indentation of multi-lines such that the quotes are aligned. To maximize space if needed you may place the first argument to `pht()` on a new line
- Prefer to use single-quotes. Use of double-quotes is preferred when the text content contains newline escapes, which won't render properly in single quote text.
- Use formatted text e.g. `pht('Welcome %s', Anything which refers to `phabricator` as a path on disk or a class $name);` instead of variable concatenation `pht('Welcome '.$name,)`. whichThis is not user-facingstrictly required except in rare circumstances, can remain for now and be addressed in a different changeas translations into other languages cannot assume placement of words that concatenation enforces.
```lang=php
$object->setValue(pht(
'... Tthis helps to limit to scope of necessary changes for the branding effort.installation requires '.
'that all blah %s blah '.
'and such',
$this->getDisplayName()));
```
==== Applications
(`pht`s denotes a simple count of how many times `pht()` shows up in the code - it should give a rough estimate of how much work each app needs.)
`/src/applications/`
| dir | `pht`s | owner | note |
| ----- | ----- | ----- | -----
| almanac | 517 | @golyalpha |
| aphlict | 47 | |
| arcanist | 0 | @avivey | done!
| audit | 137 | |
| auth | 1248 | @speck |
| badges | 169 | |
| base | 26 | |
| cache | 60 | |
| calendar | 648 | |
| celerity | 36 | |
| chatlog | 15 | |
| conduit | 239 | |
| config | 1170 | @Matthew | Also includes setup issue links I believe |
| conpherence | 173 | |
| console | 71 | |
| countdown | 79 | |
| daemon | 241 | |
| dashboard | 372 | |
| differential | 1310 | |
| diffusion | 1507 | |
| diviner | 129 | |
| doorkeeper | 54 | |
| draft | 0 | @avivey |
| drydock | 525 | @golyalpha |
| fact | 84 | |
| favorites | 4 | |
| feed | 64 | |
| files | 612 | |
| flag | 49 | |
| fund | 126 | |
| guides | 41 | |
| harbormaster | 955 | |
| help | 11 | |
| herald | 545 | |
| home | 14 | |
| legalpad | 227 | |
| lipsum | 21 | |
| macro | 145 | |
| maniphest | 670 | |
| meta | 96 | |
| metamta | 400 | |
| multimeter | 36 | |
| notification | 50 | |
| nuance | 242 | |
| oauthserver | 142 | |
| owners | 224 | |
| packages | 146 | |
| passphrase | 165 | |
| paste | 130 | |
| people | 589 | |
| phame | 355 | |
| phid | 23 | |
| phlux | 28 | |
| pholio | 144 | |
| phortune | 840 | |
| phpast | 10 | |
| phragment | 121 | |
| phrequent | 53 | |
| phriction | 241 | |
| phurl | 86 | |
| policy | 173 | |
| ponder | 173 | |
| project | 955 | |
| releeph | 331 | |
| remarkup | 3 | |
| repository | 775 | |
| search | 521 | |
| settings | 368 | |
| slowvote | 106 | |
| spaces | 97 | |
| subscriptions | 67 | |
| support | 1 | |
| system | 87 | |
| tokens | 62 | |
| transactions | 581 | |
| typeahead | 54 | |
| uiexample | 462 | |
| xhprof | 31 | |
`/src/infrastructure/`:
| dir | `pht`s | owner | note |
| ----- | ----- | ----- | -----
| cache | 8 | |
| cluster | 57 | |
| contentsource | 24 | |
| customfield | 97 | |
| daemon | 263 | |
| diff | 91 | |
| edges | 32 | |
| editor | 16 | |
| env | 35 | |
| events | 2 | |
| export | 21 | |
| graph | 11 | |
| internationalization | 17 | |
| javelin | 0 | |
| lint | 13 | |
| lipsum | 2 | |
| log | 4 | |
| management | 4 | |
| markup | 46 | |
| parser | 5 | |
| PhabricatorEditor.php | 0 | |
| query | 49 | |
| ssh | 3 | |
| status | 4 | |
| storage | 281 | |
| syntax | 1 | |
| testing | 4 | |
| time | 2 | |
| util | 72 | |
`/src/docs/`
{T15012}
| directory | total lines | owner | notes
|---|---|---|--- |
| book | 466 | @Matthew | |
|contributor | 3027 | @Matthew| |
|flavor| 1566 | @Matthew | |
|tech | 163 | @Matthew | |
|user |18455 | @Matthew | |