WordPress / meta-environment

A collection of scripts that provision the official WordPress.org websites into a Varying Vagrant Vagrants installation.
190 stars 69 forks source link

Include a config example on the readme #99

Open tomjn opened 7 years ago

tomjn commented 7 years ago

I'm intending to link here from the VVV docs, but there's no example of how to add this to a VVV install :(

It should be an easy copy paste into vvv-custom.yml, e.g.:

  wordpress-meta-environment:
    repo: https://github.com/WordPress/meta-environment.git
    hosts:
      - wp-meta.dev
grappler commented 7 years ago

This has been documented here: https://github.com/WordPress/meta-environment/blob/master/docs/install.md

But it not always clear from the readme.

tomjn commented 7 years ago

I'm hoping to link directly to it from the new VVV dashboard, so having it right at the top of the readme or as close to the top as is feasible would be great.

I'd also recommend adding wp-meta.dev as a host, else it won't show the meta environment in the list of sites. I'd also recommend a description field

ocean90 commented 7 years ago

I don't think we need this in readme directly. There is already a link to the install.md.

Anyway, we should update the config after 7b8ae06374fd55b547a6161d7f28735eeca1a8ed

  wordpress-meta-environment:
    description: "An environment useful for contributions to the WordPress meta team."
    repo: https://github.com/WordPress/meta-environment.git
    hosts:
      - wp-meta.dev
    custom:
      provision_site:
        "buddypressorg.dev": true
        "jobs.wordpressnet.dev": true
        "wordcamp.dev": true
        "wordpressorg.dev": true
        "wordpresstv.dev": true
ocean90 commented 7 years ago

Updated config example in https://github.com/WordPress/meta-environment/compare/39a84366e18af7c71666dfb88a095ec10b197e83...e181d92730207a0530902c710a76e83b34dbd3d2.