Documentation: Dev Environment Setup

To contribute to the Flyway documentation site you will need to set up your development environment so that you run the website locally and submit changes.

For this you will need to set up Git, Make, Docker and an editor.

Prerequisites

• Git
• Docker
• Make:
  • Windows: choco install make
  • Ubuntu: sudo apt install make
  • macOS: xcode-select --install (available as part of the Command Line Tools for Xcode)

Editor

The documentation site uses HTML files with Liquid headers for Jekyll. We personally use IntelliJ, which works quite well, but feel free to use any editor that suits you.

Done!

Congratulations! You now have a fully functional dev environment for the Flyway documentation site. You can start contributing!