Jump directly to the main points, no "beginner level" tutorials, contain the real case study,... These are what you can expect from our handbook.
We are using Trello to manage our tasks. You can check it out here.
docker-compose upThis will automatically create a local server run at port 4000.
You need to install Ruby and Jekyll, then install every dependencies for this project. We are using theme Minimal Mistakes for the handbook. There are many online tutorials can help you setup easily so we don't specify the steps here.
Build the website:
./build.shBuild the website and run a live reload server: (similar to running docker compose)
./serve.shEdit your post in docs/_posts/.
The category of the post should be one of these:
- Computer science
- Economics & Finance
Here is a sample: Docker
A post should have at least these sections: introduction, references and contributors.
The main contributor should have the dagger symbol next to his name.
When a post come to the "review" stage, the reviewer assigned to that post should review the post and feedback to the editor. After everything is fine, the author need to make a merge request contains that post to the main branch.
Our admin team will decide which posts can be published on the handbook.
If you feel interested in our handbook, please leave comment under each post or send an email to this address.