/docs

The main docs site for Lando

Primary LanguageVueGNU General Public License v3.0GPL-3.0

Lando Docs

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:

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.

Issues, Questions and Support

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.

Changelog

We try to log all changes big and small in both THE CHANGELOG and the release notes.

Development

  • Requires Node 14+
  • Prefers Yarn
  • Alternatively you can also use Lando
git clone https://github.com/lando/docs.git && cd docs

Using Node/Yarn

# Install deps
yarn | npm install

# Launch dev site
yarn dev

# Lint
yarn lint

# Build site
yarn build

Using Lando

# Install deps
lando start

# Launch dev site
lando dev

# Lint
lando yarn lint

# Build site
lando yarn build

Releasing

yarn release

Contributors

Made with contributors-img.

Other Resources