docs: use shell-portable env var names in install examples

[IsmaelMartinez]

PR Summary by Qodo

Docs: use shell-portable double-underscore env var names in install examples
📝 Documentation 🕐 Less than 10 minutes

Walkthroughs

User Description

What

The install docs document env vars in the dotted form (GITHUB.BASE_URL, OPENAI.KEY, ...). Dynaconf accepts both the dotted and double-underscore forms, but most shells can't export a name containing a dot, and a GitHub Actions env: block with a dotted key is similarly problematic, so users copying these examples hit failures (#2310).

Fix

Switch the example commands in installation/locally.md (the docker -e examples) and installation/github.md (the GitHub-enterprise env: block) to the equivalent double-underscore form (GITHUB__BASE_URL), which works everywhere and which the existing .env example and help_docs.md already use. The convention note that documents both forms is left intact, since both remain valid at the config layer.

Fixes #2310.

AI Description

• Replace dotted env var names with double-underscore equivalents in install examples.
• Fix copy/paste failures in shells and GitHub Actions env: blocks.
• Keep configuration convention unchanged (both forms still supported by Dynaconf).

Diagram

graph TD
  U(["User"]) --> D["Installation docs"] --> R(["Docker run / GitHub Action"]) --> E{{"Environment variables"}} --> A["PR-Agent"]

  subgraph Legend
    direction LR
    _user(["Actor"]) ~~~ _step["Step/Component"] ~~~ _cfg{{"Config"}}
  end

Loading

High-Level Assessment

The chosen approach is optimal: standardize docs examples on the double-underscore form that works in shells and GitHub Actions while remaining equivalent in Dynaconf. Considered alternatives (keeping dotted examples with warnings, or mixing both forms inline) add confusion and still lead to copy/paste failures.

File Changes

Documentation (2)

github.md Fix GitHub Enterprise env var example to use 'GITHUB__BASE_URL' +2/-2

Fix GitHub Enterprise env var example to use 'GITHUB__BASE_URL'

• Updates the GitHub Enterprise Server setup instructions to use the shell/GitHub-Actions-safe double-underscore env var name. Adjusts both the narrative text and the YAML 'env:' example key accordingly.

docs/docs/installation/github.md

---

locally.md Make Docker '-e' install examples shell-portable (double-underscore env vars) +8/-8

Make Docker '-e' install examples shell-portable (double-underscore env vars)

• Replaces dotted env var names in 'docker run -e ...' examples across GitHub/GitLab/Bitbucket/Gitea sections with double-underscore equivalents. Also updates the generic guidance line to reference 'CONFIG__GIT_PROVIDER' consistently.

docs/docs/installation/locally.md

---

[qodo-free-for-open-source-projects]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review