Contrib.social

Clarify Optional Configurations in GTM Barebones Documentation

Open on Drupal.org →
Created on 29 May 2024, 10 months ago

Problem/Motivation

The current documentation for the GTM Barebones module does not clearly state that the environment_id and environment_token configurations are optional. This might lead to confusion among users who might assume these configurations are mandatory for the module's functionality.

Steps to reproduce

  1. Read the current documentation of the GTM Barebones module.
  2. Note the lack of clarity regarding the optional nature of environment_id and environment_token.

Proposed resolution

Update the module documentation to explicitly state that the environment_id and environment_token configurations are optional. Here is the proposed update:

$config['gtm_barebones.settings']['container_id'] = 'GTM-ABCDEFGHIJK';
// Optional configurations
$config['gtm_barebones.settings']['environment_id'] = 'env-123456';
$config['gtm_barebones.settings']['environment_token'] = 'iBN8NANliiuqnAAi81LapqkkdUIjak';

Remaining tasks

  • Update the documentation file with the proposed changes.
  • Review and test the documentation to ensure clarity and correctness.
  • Push the changes to the module repository.

User interface changes

None

API changes

None

Data model changes

None

📌 Task
Status

Active

Version

1.0

Component

Documentation

Created by

🇦🇺Australia amjad1233 Brisbane

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

Comments & Activities

  • Issue created by @amjad1233
  • Comment 10 months ago →
    🇦🇺Australia dpi Perth, Australia

    his might lead to confusion among users who might assume these configurations are mandatory for the module's functionality.

    Well, there isnt a cost (in any metric) to filling these things out. To be honest I think we just need to document it clearly, per 📌 Add guidance to readme for how to find all three configs in GTM Active .

    This way we do not need to work around different script configurations. After all, the guiding principle of this module is to be as simple as possible.

    Also, filling these fields implicitly educates the developer that the environments can vary easily, making their CI/Testing/Nonprod setup clear.

    In my opinion, this is a wont fix.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024