lando / docs

The main docs site for Lando
https://docs.lando.dev/
GNU General Public License v3.0
18 stars 56 forks source link

Documentation: "overrides" #20

Open rubenvarela opened 2 years ago

rubenvarela commented 2 years ago

Please complete the following:

Link to the page that needs to be updated or changed. https://docs.lando.dev/config/lando.html#base-file

Describe the change you'd like

Currently the page has this paragraph,

If you are developing a project start state or have a set of Lando configurations you'd like to ship with all your projects, you can use a "base" file with defaults that can then be overridden by your usual .lando.yml. By default, Lando will detect automatically and load before your .lando.yml any of the files as follows:

Not sure what the exact wording should be, but "overridden" is misleading in some cases.

$ cat .lando.base.yml
  services:
    appserver:
      run:
        - echo '.lando.base.yml'
$ cat .lando.dist.yml
  services:
    appserver:
      run:
        - echo '.lando.dist.yml'
$ cat .lando.yml
  name: my-lando-app
  recipe: lamp
  config:
    webroot: .
  services:
    appserver:
      run:
        - echo '.lando.yml'
$ cat .lando.local.yml
  services:
    appserver:
      run:
        - echo '.lando.local.yml'

If you define these three files, the key services.appserver.run isn't overridden. It's executed one after the order in the priority they have. This yields,

...

Scanning to determine which services are ready... Please standby...
.lando.base.yml
.lando.dist.yml
.lando.yml
.lando.local.yml

...
reynoldsalec commented 2 years ago

Interesting, @pirog do you think this is behavior that should actually change in Lando itself? Might classify this as a bug in lando/lando for our 4.x release, not a docs issue.

stale[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions and please check out this if you are wondering why we auto close issues.