Skip to content

Commit

Permalink
Merge pull request #3661 from uselagoon/docs-local-dev-options
Browse files Browse the repository at this point in the history
Adding DDEV to local dev docs.
  • Loading branch information
Alanna Burke authored Feb 27, 2024
2 parents 5ac6dae + 5d8cb60 commit c48d613
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
14 changes: 2 additions & 12 deletions docs/using-lagoon-the-basics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,9 @@ To run a Lagoon Project, your system must meet the requirements to run Docker. W

### Local Development Environments

TL;DR: install and start `pygmy`:
You can choose from pygmy, Lando, or DDEV - it's up to you!

```bash
brew tap pygmystack/pygmy; # (1)
brew install pygmy;
pygmy up
```

1. HomeBrew is the easiest way to install Pygmy, see the Pygmy docs for more info.

[Pygmy](https://github.com/pygmystack/pygmy/) is a container stack for local development, developed collaboratively with the Lagoon team.

Learn more about Lagoon, pygmy, and [Local Development Environments](local-development-environments.md)
Learn more about Lagoon and [Local Development Environments](local-development-environments.md)

## Step by Step Guides

Expand Down
14 changes: 11 additions & 3 deletions docs/using-lagoon-the-basics/local-development-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ Even though Lagoon has only a hard dependency on Docker and [Docker Compose](htt
???+ warning
You do not need to _install_ Lagoon locally to _use_ it locally! That sounds confusing but follow the documentation. Lagoon is the system that **deploys** your local development environment to your production environment, it's **not** the environment itself.

## pygmy or Lando - the choice is yours
## pygmy, DDEV, or Lando - the choice is yours

### pygmy

Lagoon has traditionally worked best with `pygmy` , which is the amazee.io flavored system of the above tools and works out of the box with Lagoon. It lives at [https://github.com/pygmystack/pygmy](https://github.com/pygmystack/pygmy)

Expand All @@ -22,8 +24,14 @@ brew tap pygmystack/pygmy && brew install pygmy

For detailed usage or installation info on pygmy, see its [documentation](https://pygmy.readthedocs.io/en/master/).

As announced in our [blog post](https://www.amazee.io/blog/post/announcing-lando-integration-for-lagoon), Lagoon is now also compatible with Lando! For more information, please see the documentation at [https://docs.lando.dev/config/lagoon.html](https://docs.lando.dev/config/lagoon.html) to get yourself up and running.
### Lando

Lagoon is well-integrated with Lando! For more information, please see the documentation at [https://docs.lando.dev/config/lagoon.html](https://docs.lando.dev/config/lagoon.html) to get yourself up and running.

Lando's workflow for Lagoon will be familiar to users of Lando, and will also be the easiest way for Lagoon newcomers to get up and running. Pygmy presents a closer integration with Docker, which will lend itself better to more complex scenarios and use cases but will also require a deeper understanding.

We have previously evaluated adding support for other systems like [Docksal](https://docksal.io/) and [Docker4Drupal](https://wodby.com/docs/stacks/drupal/local/), and while we may add support for these in the future, our current focus is on supporting using Lando and pygmy. If you do have Lagoon running with one of these \(or other\) tools, we would love for you to submit a [PR on GitHub](https://github.com/pygmystack/pygmy)!
### DDEV

Lagoon is also supported on DDEV! Check out their documentation to get started: [https://ddev.readthedocs.io/en/stable/users/providers/lagoon/](https://ddev.readthedocs.io/en/stable/users/providers/lagoon/).

We have previously evaluated adding support for other systems like [Docksal](https://docksal.io/) and [Docker4Drupal](https://wodby.com/docs/stacks/drupal/local/), and while we may add support for these in the future, our current focus is on supporting our current tools.

0 comments on commit c48d613

Please sign in to comment.