From c897dc04e5c407874f6fa0cf9348f462b7f00381 Mon Sep 17 00:00:00 2001 From: epriestley Date: Fri, 22 Mar 2013 11:54:49 -0700 Subject: [PATCH] Update DarkConsole documentation Summary: This is a little bit out of date. Notably, the setting changed locations and we no longer have a "Config" tab since it's available in the config app. Test Plan: Read documentation. Reviewers: chad, skrul Reviewed By: skrul CC: aran Differential Revision: https://secure.phabricator.com/D5415 --- src/docs/developer/darkconsole.diviner | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/src/docs/developer/darkconsole.diviner b/src/docs/developer/darkconsole.diviner index 7f15f7fd98..3a15c0eb02 100644 --- a/src/docs/developer/darkconsole.diviner +++ b/src/docs/developer/darkconsole.diviner @@ -14,21 +14,22 @@ DarkConsole was originally implemented as part of the Facebook Lite site; its name is a bit of play on that (and a reference to the dark color palette its design uses). -= Enabling DarkConsole = += Warning = Because DarkConsole exposes some configuration and debugging information, it is disabled by default (and **you should not enable it in production**). It has -some simple safeguards to prevent leaking credential information but enabling it -in production may compromise the integrity of an install. +some simple safeguards to prevent leaking credential information, but enabling +it in production may compromise the integrity of an install. -You enable DarkConsole in your configuration, by setting ##darkconsole.enabled## -to ##true##, and then clicking the "Enable DarkConsole" link in the page footer. += Enabling DarkConsole = + +You enable DarkConsole in your configuration, by setting `darkconsole.enabled` +to `true`, and then turning it on in `Settings` -> `Display Preferences`. Once DarkConsole is enabled, you can show or hide it by pressing ##`## on your keyboard. -Since the "Enable DarkConsole" link is not available to logged-out users (and -stored as a per-user preference), you can also set ##darkconsole.always-on## if -you need to access DarkConsole on logged-out pages. +Since the setting is not available to logged-out users, you can also set +`darkconsole.always-on` if you need to access DarkConsole on logged-out pages. DarkConsole has a number of tabs, each of which is powered by a "plugin". You can use them to access different debugging and performance features. @@ -57,7 +58,3 @@ The "XHProf" plugin gives you access to the XHProf profiler. To use it, you need to install the corresponding PHP plugin -- see instructions in the @{article:Installation Guide}. Once it is installed, you can use XHProf to profile the runtime performance of a page. - -= Plugin: Config = - -The "Config" plugin shows active Phabricator configuration values.