humanmade / humanmade/altis-documentation
Document how to define a custom environment, eg. for CI
- Dominant language
- PHP
- Stars
- 6
- Forks
- 3
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 2
Description
The configuration defaults are currently tailored to our stack and the local environments and doesn't properly account for cases where a custom environment and set of overrides would be needed, for instance on CircleCI.
It's possible to define the constant `HM_ENV_TYPE` and use that value in the config `environments` section so we should document how to do that.
Props to @Nikschavan for raising this.
---------
Acceptance criteria:
- [ ] Add a section to the `configuration.md` doc in the getting started guides titled "Defining a custom environment"
- Explain the use cases eg. changing config for a CI environment
- Add an example of defining `HM_ENV_TYPE` in the `.config/load.php` if any CircleCI or Travis CI environment variables are found
- Show an example config using this custom environment to turn off certain features
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.