From 003cb0c47bdc05cdf914d8ae4fced262c5427419 Mon Sep 17 00:00:00 2001 From: M Parker Date: Mon, 7 Dec 2015 22:40:41 -0500 Subject: [PATCH] 2610216-2 --- README.md | 156 +++++++++++++++++++++++++++++++++++-------- environment_indicator.module | 2 - 2 files changed, 130 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 0ab960e..138d14f 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,159 @@ -## SUMMARY +INTRODUCTION +------------ -Environment Indicator adds a coloured strip to the site informing the user which -environment they are in (Development, Staging, Production, etc). +Designed to keep you sane while working on different copies of your site +(Development, Staging, Production, etc.), Environment Indicator adds some +visual cues (displaying a colored bar, changing the background color of the +toolbar, and an overlay on the site's favicon) to indicate which copy of the +site you are interacting with. -For a full description visit the project page: - http://drupal.org/project/environment_indicator +This is incredibly useful if you have multiple environments for each of your +sites, and like me, are prone to forgetting which version of the site you are +currently looking at. -Bug reports, feature suggestions and latest developments: - http://drupal.org/project/issues/environment_indicator +Environment Indicator can also be configured to add links to the other copies of +the site, in case you find yourself on the wrong one and want to quickly jump to +another. +REQUIREMENTS +------------ -## REQUIREMENTS +No special requirements. -* None +RECOMMENDED MODULES +------------------- + * The Toolbar module (which ships with core): + When enabled, Environment Indicator adds an item to it and changes its + background color. -## INSTALLATION +INSTALLATION +------------ -* Install as usual, see [here](http://drupal.org/node/70151) for further information. + * Install as you would normally install a contributed Drupal module. See: + https://drupal.org/documentation/install/modules-themes/modules-7 + for further information. +CONFIGURATION +------------- -## CONFIGURATION +In order for a user to see the environment indicator, they will need the "See +environment indicator" permission. -You may configure the environment at /admin/config/development/environment-indicator +Global options, such as whether to try to determine the Git branch when the +environment name is unavailable, whether to change the background of the +Toolbar, and whether to show an overlay on top of the favicon, can be configured +from the settings page at admin/config/development/environment-indicator. In +order for a user to change the global options, they will need the "Administer +environment_indicator settings" permission. -You need to set the configuration using your `settings.php`: +Since each copy of the site should have it's own `settings.local.php` (to store +database credentials without checking them into version control), you must +configure Environment Indicator by adding some configuration overrides to +`settings.local.php`: - * `$config['environment_indicator.indicator']['bg_color']`: + * `$config['environment_indicator.indicator']['bg_color']`: - A valid CSS color for the background of the indicator. + The background color for the indicator (or Toolbar). Must be a string + containing a valid CSS color (including the leading # if using hexadecimal + notation). See http://www.w3.org/TR/css3-color#colorunits for more + information. - * `$config['environment_indicator.indicator']['fg_color']`: + If you have the typical "development-staging-production" environments, it can + be helpful to choose "stoplight colors" - green for development (to indicate + that most changes are okay), yellow for staging (to indicate caution, as + clients may be working on staging), and red for production (to indicate that + you are making changes to a live website). - A valid CSS color for the text of the indicator. + This configuration is optional. If you do not set it, the background color + will be inherited from the CSS styles on the page. - * `$config['environment_indicator.indicator']['name']`: + * `$config['environment_indicator.indicator']['fg_color']`: - The text that will be displayed on the indicator. + The text color for the environment name. Must be a string containing a valid + CSS color (including the leading # if using hexadecimal notation). See + http://www.w3.org/TR/css3-color#colorunits for more information. - * `$config['environment_indicator.indicator']['position']`: + To be readable, the text color must contrast with the background color. See + http://www.w3.org/TR/WCAG20/#visual-audio-contrast-contrast for more + information about choosing contrasting colors which meet accessibility + standards. - Where your indicator may appear. Allowed values are "top" and "bottom". + This configuration is optional. If you do not set it, the text color will be + inherited from the CSS styles on the page. - * `$config['environment_indicator.indicator']['fixed']`: + * `$config['environment_indicator.indicator']['name']`: - A boolean value indicating whether the Environment Indicator should be visible at all times, fixed at the top/bottom of the screen. + A string of text to display indicate the environment name. Note that Drupal's + translation system has not yet been boostrapped when `settings.local.php` is + run, so you cannot use the t() function here. + + This configuration is optional. If you do not set it, Environment Indicator + will try to find the name of the current git branch. If the current git + branch name cannot be determined, then it will appear as an empty string. + +An example configuration could look like: ```php $config['environment_indicator.indicator']['bg_color'] = '#FF5555'; -$config['environment_indicator.indicator']['fixed'] = FALSE $config['environment_indicator.indicator']['fg_color'] = '#555533'; $config['environment_indicator.indicator']['name'] = 'Staging'; -$config['environment_indicator.indicator']['position'] = FALSE; ``` + +To add links to switch to other environments, you must add a configuration for +each environment at admin/config/development/environment-indicator/switcher. +This configuration can copied to other environments using Drupal core's +configuration management system. See +https://www.drupal.org/documentation/administer/config for more information. In +order for a user to add environment switchers, they will need the "Administer +environment_indicator settings" permission. + +TROUBLESHOOTING +--------------- + +If your configuration is in `settings.local.php`, but is not showing up, you may +need to enable the file by uncommenting the appropriate lines from the bottom of +`settings.php`. + +If your configuration is in `settings.local.php`, but is not showing up for a +particular user, you may need to grant that user the "See environment indicator" +permission. + +If you encounter fatal errors ("white screens of death") after making changes to +`settings.local.php`, there may be a syntax error. You can check for syntax +errors by running `php -l settings.local.php`. + +If you find any bugs, have any suggestions for new features, or are interested +in the latest developments to this module, please visit +https://www.drupal.org/project/issues/environment_indicator for more +information. + +FAQ +--- + +Q: What happened to the feature which allowed me to save environment + configurations that would be selected by looking at the request URL? + +A: This feature has been removed from the 8.x-3.x branch. + +Q: What happened to the feature which allowed me to position the environment + indicator at the bottom of the screen? + +A: This feature has been removed from the 8.x-3.x branch. + +Q: What happened to the feature which allowed me to display the environment + indicator in a fixed position in the browser window, regardless of where I + scrolled? + +A: This feature has been removed from the 8.x-3.x branch. + +MAINTAINERS +----------- + +Current maintainers: +* e0ipso - https://www.drupal.org/u/e0ipso +* Tom Kirkpatrick (mrfelton) - https://www.drupal.org/u/mrfelton + +This project has been sponsored by: +* Lullabot (Development and maintenance for the 7.x-2.x & 8.x-2.x branches). +* SystemSeed (Development and maintenance for hte 6.x-1.x & 7.x-1.x branches). diff --git a/environment_indicator.module b/environment_indicator.module index 2ccccdc..45290ab 100644 --- a/environment_indicator.module +++ b/environment_indicator.module @@ -34,8 +34,6 @@ function environment_indicator_help($route_name, RouteMatchInterface $route_matc $output .= '
$config[\'environment_indicator.indicator\'][\'bg_color\']
' . t('A valid CSS color for the background of the indicator.') . '
$config[\'environment_indicator.indicator\'][\'bg_color\'];
'; $output .= '
$config[\'environment_indicator.indicator\'][\'fg_color\']
' . t('A valid CSS color for the text of the indicator.') . '
$config[\'environment_indicator.indicator\'][\'fg_color\'] = \'#555533\';
'; $output .= '
$config[\'environment_indicator.indicator\'][\'name\']
' . t('The text that will be displayed on the indicator.') . '
$config[\'environment_indicator.indicator\'][\'name\'] = \'Staging\';
'; - $output .= '
$config[\'environment_indicator.indicator\'][\'position\']
' . t('Where your indicator may appear. Allowed values are "top" and "bottom".') . '
$config[\'environment_indicator.indicator\'][\'position\']
'; - $output .= '
$config[\'environment_indicator.indicator\'][\'fixed\']
' . t('A boolean value indicating whether the Environment Indicator should be visible at all times, fixed at the top/bottom of the screen.') . '
$config[\'environment_indicator.indicator\'][\'fixed\']
'; $output .= ''; return $output; -- 2.6.2