You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 😃
Writing Documentation
There's no too much of a reference for this doc. We have the unit tests here but 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! 😃
The text was updated successfully, but these errors were encountered:
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
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 runjekyll serve
.If you don't have it yet you will need to install jekyll, it's fairly easy 😃
Writing Documentation
There's no too much of a reference for this doc. We have the unit tests here but 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! 😃
The text was updated successfully, but these errors were encountered: