Differential D25007 Diff 21 src/docs/contributor/developer_setup.diviner

Changeset View

Standalone View

src/docs/contributor/developer_setup.diviner

	@title Developer Setup			@title Developer Setup
	@group developer			@group developer

	How to configure a Phabricator development environment.			How to configure a Phorge development environment.

	Overview			Overview
	========			========

	There are some options and workflows that may be useful if you are developing			There are some options and workflows that may be useful if you are developing
	or debugging Phabricator.			or debugging Phorge.


	Configuration			Configuration
	=============			=============

	To adjust Phabricator for development:			To adjust Phorge for development:

	- Enable `phabricator.developer-mode` to enable some options and show			- Enable `phabricator.developer-mode` to enable some options and show
	more debugging information.			more debugging information.
	- Enable `phabricator.show-prototypes` to show all the incomplete			- Enable `phabricator.show-prototypes` to show all the incomplete
	applications.			applications.
	- See @{article: Using DarkConsole} for instructions on enabling the			- See @{article: Using DarkConsole} for instructions on enabling the
	debugging console.			debugging console.

	Show All 18 Lines

	Utilities			Utilities
	=========			=========

	After adding, renaming, or moving classes, run `arc liberate` to rebuild			After adding, renaming, or moving classes, run `arc liberate` to rebuild
	the class map:			the class map:

	```			```
	phabricator/ $ arc liberate			phorge/ $ arc liberate
	```			```

	Until you do this, Phabricator won't recognize your new, moved, or renamed			Until you do this, Phorge won't recognize your new, moved, or renamed
	classes. You do not need to run this after modifying an existing class.			classes. You do not need to run this after modifying an existing class.

	After any modifications to static resources (CSS / JS) but before sending			After any modifications to static resources (CSS / JS) but before sending
	changes for review or pushing them to the remote, run `bin/celerity map`:			changes for review or pushing them to the remote, run `bin/celerity map`:

	```			```
	phabricator/ $ ./bin/celerity map			phorge/ $ ./bin/celerity map
	```			```

	This rebuilds the static resource map.			This rebuilds the static resource map.

	If you forget to run these commands you'll normally be warned by unit tests,			If you forget to run these commands you'll normally be warned by unit tests,
	but knowing about them may prevent confusion before you hit the warnings.			but knowing about them may prevent confusion before you hit the warnings.


	Show All 16 Lines
	Custom Domains			Custom Domains
	==============			==============

	If you're working with applications that support custom domains (like Phurl or			If you're working with applications that support custom domains (like Phurl or
	Phame) you can normally test them by adding more entries to your webserver			Phame) you can normally test them by adding more entries to your webserver
	configuration that look exactly like the primary entry (or expanding the			configuration that look exactly like the primary entry (or expanding the
	primary entry to match more domains).			primary entry to match more domains).

	Phabricator routes all requests based on host headers, so alternate domains			Phorge routes all requests based on host headers, so alternate domains
	do not normally need any kind of special configuration.			do not normally need any kind of special configuration.

	You may also need to add `/etc/hosts` entries for the domains themselves.			You may also need to add `/etc/hosts` entries for the domains themselves.


	Creating Test Data			Creating Test Data
	==================			==================

	You can create test objects with the "Lipsum" utility:			You can create test objects with the "Lipsum" utility:

	```			```
	phabricator/ $ ./bin/lipsum help generate			phorge/ $ ./bin/lipsum help generate
	phabricator/ $ ./bin/lipsum generate ...			phorge/ $ ./bin/lipsum generate ...
	```			```

	Test data can make your local install feel a little more realistic. With			Test data can make your local install feel a little more realistic. With
	`--quickly`, you can generate a large amount of test data to help test issues			`--quickly`, you can generate a large amount of test data to help test issues
	with performance or scale.			with performance or scale.