Important
As of Lando v3.23.0 the docs are now part of @lando/core and this repo is now archived eg longer actively maintained, used, looked at, etc.
Please visit @lando/core for anything docs related.
This repo contains the documentation site for Lando. That said Lando is comprised of various constituent projects that are all combined together. So while this is the main site you should think about it more as the "glue" that combines various subsites together into a cohesive docs expereince. Said more plainly. if you are looking to update the docs on say the Lagoon recipe then you should do so in the Lagoon repo.
Here is a non-exhaustive list of some of the other docs subsites:
- https://github.com/lando/cli/tree/main/docs
- https://github.com/lando/core/tree/main/docs
- https://github.com/lando/php/tree/main/docs
- https://github.com/lando/pantheon/tree/main/docs
However, it's best to just search for the repo you are looking for in the main Lando org and consult its README on how to update its docs.
If you have a question or would like some community support we recommend you join us on Slack. Note that this is the Slack community for Lando but we are more than happy to help with this module as well!
If you'd like to report a bug or submit a feature request then please use the issue queue in this repo.
We try to log all changes big and small in both THE CHANGELOG and the release notes.
- Requires Node 18+
# Clone repo
git clone https://github.com/lando/docs.git && cd docs
# Install deps
npm install
# Launch dev site
npm run dev
# Lint
npm run lint
# Build site
npm run buildTo deploy and publish a new version of the package to the npm registry you need only create a release on GitHub with a semver tag.
Note that prereleases will get pushed to the edge tag on the npm registry.
Made with contributors-img.
- Important advice
- Other stuff