Skip to content

docs: expand environment customization guide#44

Open
lbajsarowicz wants to merge 1 commit intowardenenv:mainfrom
lbajsarowicz:feat/customizing-docs
Open

docs: expand environment customization guide#44
lbajsarowicz wants to merge 1 commit intowardenenv:mainfrom
lbajsarowicz:feat/customizing-docs

Conversation

@lbajsarowicz
Copy link
Contributor

Summary

  • Rewrites the "Customizing An Environment" page to fully document the .warden/warden-env.yml override mechanism
  • Removes the "forthcoming" disclaimer that's been there since the page was created
  • Removes outdated version: "3.5" from Docker Compose examples

What's new

  • Docker Compose Overrides section explaining merge precedence (loaded last = highest priority)
  • OS-specific overrides (.warden/warden-env.darwin.yml, .warden/warden-env.linux.yml)
  • Custom Docker image example (overriding php-fpm image)
  • Adding extra services example (adminer with Traefik routing)
  • warden env config tip for previewing the merged configuration
  • Advanced: Project-Level Environment Partials documenting the .warden/environments/ directory structure and full search order
  • Updated Multiple Domains to use a relative link instead of hardcoded URL

Existing content preserved

  • .env variable customization (PHP_VERSION, service versions, toggles)
  • PHP config override example (updated syntax)
  • Nginx config override example (updated syntax)
  • Magento 1/2 specific customizations (unchanged)

Test plan

  • Build docs with make html and verify rendered output
  • All internal links resolve correctly
  • Examples are valid YAML without deprecated version key

⭐ Support my work

Do you like the fix? Remember to react with "👍🏻" to get it merged faster,
Then Sponsor me on Github so I can spend more time on fixing issues like this one.

Learn more at https://github.com/sponsors/lbajsarowicz

Rewrite the customizing environments page to document the full
.warden/warden-env.yml override mechanism including merge precedence,
OS-specific overrides, custom Docker images, extra services, and
project-level environment partials.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant