This project is awesome but IMO super underrated so I want to change that. And in order to do so I'm calling out all the awesome OSS developers out in the community to make a first contribution!
Getting Started
All you need is to fork this repo, pick one issue (please announce it in the corresponding Github issue to avoid duplicated work) and create a Pull Request once you're done.
The documentation is compiled using tut. You can see whether your work compiles or not by running the following commands:
> sbt
> project microsite
> makeMicrosite
This will run tut and if it compiles it will generate the static HTML / CSS / JS files. To have a local preview of the microsite you need to access the directory $PROJECT/site/target/site and run jekyll serve.
If you don't have it yet you will need to install jekyll, it's fairly easy :smiley:
Writing Documentation
This library exports a module named test-support which includes support for Docker so you can write integration tests very easily. Here's the link of the sub-module. It will also be necessary to add another section in the menu which means editing the menu.yml file (suggestions very welcome).
Should you need any help please reach out on the Gitter channel, thanks for contributing! :smiley:
Motivation
This project is awesome but IMO super underrated so I want to change that. And in order to do so I'm calling out all the awesome OSS developers out in the community to make a first contribution!
Getting Started
All you need is to fork this repo, pick one issue (please announce it in the corresponding Github issue to avoid duplicated work) and create a Pull Request once you're done.
The documentation is compiled using tut. You can see whether your work compiles or not by running the following commands:
This will run
tutand if it compiles it will generate the static HTML / CSS / JS files. To have a local preview of the microsite you need to access the directory$PROJECT/site/target/siteand runjekyll serve.If you don't have it yet you will need to install jekyll, it's fairly easy :smiley:
Writing Documentation
This library exports a module named
test-supportwhich includes support forDockerso you can write integration tests very easily. Here's the link of the sub-module. It will also be necessary to add another section in the menu which means editing themenu.ymlfile (suggestions very welcome).Should you need any help please reach out on the Gitter channel, thanks for contributing! :smiley: