Update internal and external documentation for 4.1.x and 5.0.x (add Extending and Developing page, update project page content)

Created on 30 July 2025, 18 days ago

Problem/Motivation

The Environment Indicator documentation has not been updated to reflect the new features and structural changes introduced in the 4.1.x and 5.0.x branches. These include:

  • Modernized CSS architecture using CSS variables for colors, borders, and sizing.
  • New environment_indicator_toolbar submodule replacing the old builtโ€‘in toolbar integration.
  • Additional permission: view environment indicator current release for finer access control.
  • Optional $settings['environment_indicator_unrestricted_access'] flag for bypassing permission checks in certain contexts.

The current documentation โ†’ does not mention these changes, which may confuse site builders and developers trying to use or integrate the module.

Proposed resolution

Update the module documentation on Drupal.org to reflect the new features and structure:

  • Project page: Add note about upgrading from older versions.
  • Types of Indicators and Integrations: Update to document the environment_indicator_toolbar submodule and note the removal of the legacy toolbar integration.
  • New "Extending and Developing" page:
    • Document how to use the environment_indicator.indicator service to retrieve the active environment programmatically.
    • List available CSS variables for theming and provide guidance for overriding them.
    • Outline submodule structure to help developers add new integrations.

Remaining tasks

  • Draft updated Project page content.
  • Draft content for the new "Extending and Developing" page.
  • Update "Types of Indicators and Integrations" page to reflect new submodules.
๐Ÿ“Œ Task
Status

Active

Version

5.0

Component

Documentation

Created by

๐Ÿ‡บ๐Ÿ‡ธUnited States trackleft2 Tucson, AZ ๐Ÿ‡บ๐Ÿ‡ธ

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024