Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] - Migrations #16

Open
gvolpe opened this issue Sep 4, 2018 · 0 comments
Open

[docs] - Migrations #16

gvolpe opened this issue Sep 4, 2018 · 0 comments

Comments

@gvolpe
Copy link
Collaborator

gvolpe commented Sep 4, 2018

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:

> 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! 😃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant