documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Environment Configuration Doc Update

Open ravenloveriel opened this issue 2 years ago • 2 comments

Re: Environment Configuration

Priority: Medium

Issue Description:

Issue: Conflicting Usage of $_ENV Global Variable in our Public Doc

The public documentation contains contradictory information regarding the use of the $_ENV global variable in PHP applications on the Pantheon platform:

In one section, it discourages customers from using $_ENV for security reasons: "For security reasons, using the $_ENV superglobal inside PHP applications is not supported." Source: Link

In another section, it encourages the use of $_ENV variables for custom configurations on Pantheon: "When incorporating custom configurations on Pantheon, use $_ENV instead of $_SERVER wherever possible." Source: Link

This discrepancy raises the question of whether the $_ENV global variable is supported on the platform or not.

Sample of a chat conversation where the customer is confused: https://app.intercom.com/a/inbox/xkegk7cr/inbox/conversation/51746601543668

Suggested Resolution

Update the docs indicating that the $_ENV global variable is supported in the platform where it is usually placed in the wp-config.php, and settings.php.

ravenloveriel avatar Aug 07 '23 03:08 ravenloveriel

👋 @ravenloveriel Thanks for opening your first issue here! @pantheon-systems/docs-admins is excited to review this!

If you like this project, please ⭐star⭐ our repo.

github-actions[bot] avatar Aug 07 '23 03:08 github-actions[bot]

Related to https://github.com/pantheon-systems/documentation/issues/8759

stevector avatar Jul 16 '24 02:07 stevector