Lambda docs

Welcome to the Lambda docs GitHub repository, the repository from which the Lambda docs site is built.

The Lambda docs site is built using the Hugo static site generator and the Docsy Hugo theme. The docs site is deployed using Cloudflare Pages.

Contributing

All contributions to the docs are appreciated, no matter how small!

If you encounter a buggy or unclear instruction, but don't know how or don't have the time to fix it, you can create a ticket by clicking Create a documentation issue at the right-hand side of the page.

You can make a quick fix to a page by clicking Edit this page at the right-hand side of the page.

You can create a new, simple page by clicking Create child page at the right-hand side of the page that you want to create a new page under.

For complex fixes and complex new pages, you'll want to follow the instructions, below, to:

1. Clone the repository and make your changes.
2. Preview your changes locally.
3. Create a pull request for review.

Cloning the repository and making changes

Begin hacking on the Lambda docs site by first forking the docs site repo. Then, clone your forked repo to your computer.

Start making your changes!

Previewing your changes locally

You should preview your changes locally to make sure they're building as expected. The recommended way to preview your changes is to use Docker Compose.

You can install Docker Compose in Ubuntu by running:

sudo apt-get install docker-compose

Then, while in the directory for your clone of the docs site repository, run:

docker-compose up --build

In your browser, navigate to http://localhost:1313. You should see a local build of the docs site with your changes. The site will automatically rebuild each time changes are made.

Creating a pull request

Create a pull request to submit your changes for review.