Documentation for KnapsackPro.com
If you found a bug in our API or you have just an idea how to improve it then please create issue here:
https://github.com/KnapsackPro/docs.knapsackpro.com/issues
We welcome any blog post in categories:
- Category: blog
- anything about testing software or CI tips for Ruby, JavaScript, Python, PHP or any other programming language
- any technical article about popular web or mobile frameworks
- anything else in your mind? Get in touch and let's talk about your idea.
- Category: techtips
- this can be super short blog post like a few sentences and block of code that solves some problem or error you found and might be helpful for others.
- tips how to do something useful on CI server
- Category: continuous_integration
- articles about integration with various CI servers and Knapsack Pro
Create a new branch and pull reqeust for your blog post. You can copy example blog post file and read it content to find out how to create a new guest post on our blog.
See _posts/2099-01-31-example-article.md
You can create thumbnail image for blog post with Memopad app which is free on iOS.
Then you need to compress image with TinyJPG.
Please ensure img tag in blog post has alt attribute.
Please create a new blog post with pull request to this repository. Your blog post will be under GNU Affero General Public License v3.0.
$ bundle install
Show post with future publish date.
$ bundle exec jekyll serve --watch --future
Now you can preview blog at http://localhost:4000/
Run to install dependencies:
$ npm install
We are using Raml, you can learn more here:
Raml files with docs are in _api directory.
Run to compile them:
$ bundle exec rake api:generate_docs
Compiled files are in api directory. Please commit them into repository.
You can run guard to recompile raml files whenever they change.
$ guard