Code Monkey home page Code Monkey logo

docs.knapsackpro.com's Introduction

docs.knapsackpro.com

Documentation for KnapsackPro.com

https://docs.knapsackpro.com

How can I report a bug or improvement

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

How to publish a new guest blog post

What can I write about?

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

How to publish guest blog post?

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.

Development of blog

$ bundle install

Show post with future publish date.

$ bundle exec jekyll serve --watch --future

Now you can preview blog at http://localhost:4000/

Development of Knapsack Pro API docs

Dependencies

Run to install dependencies:

$ npm install

We are using Raml, you can learn more here:

Generate API docs

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.

Guard

You can run guard to recompile raml files whenever they change.

$ guard

docs.knapsackpro.com's People

Contributors

arturt avatar dependabot[bot] avatar ivanfon avatar jeroenj avatar kenzan100 avatar shadre avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.