All things docs about CartoDB. This repo contains all that will be found in docs.cartodb.com - It's meant to be an open resource so that anyone can contribute information to our docs. It features a guide of the CartoDB Editor, Tutorials, Tips and Tricks, and CartoDB Platform.

If you spot a typo, want to add a FAQ, or contribute a tutorial, just send a Pull Request! Check our CONTRIBUTING page.

CartoDB Docs uses a mix of Jekyll and Grunt tasks for development. Thus you'll need Ruby and a Node.js version >= 0.10.0 installed, as well as Bundlr.

bundle install
npm install -g grunt-cli
npm install

grunt serve

A tab in your browser will open and direct you to http://0.0.0.0:9000

Also, you can run the blog locally as if it was on production with grunt serve:dist

In case you stuble upon the next error:

Error: Unable to read "grunt-aws.json" file (Error code: ENOENT).

you'll need a grunt-aws.json credentials file, find more info in deploy section.

If you can't find the docs for CartoDB.js, the SQL API or Maps API it's possible you didn't run docs_build.sh yet. Check how to do this in the How to contribute section.

You'll need wgetand sed in order for the script work.

grunt deploy:staging|production

You'll need a grunt-aws.json credentials file. You can copy the grunt-aws.example.json to grunt-aws.json to work locally.

CartoDB Docs is in itself an open project, and we welcome contributions. If you spot a typo, want to expand some explanation, add some trick or FAQ you see missing, or event create a Tutorial, we welcome you to do so. We would need that everything you contribute follow the style of what's already on place. If you want to contribute something and have doubts about how to so, you can contact [email protected]

Documentation for the components of the CartoDB platform rely on their own project, so make the edit in their corresponding documentation and then run sh docs_build.sh to pull them:

• Cartodb.js
• SQL API
• Maps API

Import API documentation is the only that must be edited in this project.

To send your contributions you can follow the standard workflow:

• Fork it ( https://github.com/cartodb/docs/fork )
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Add some feature')
• Push to the branch (git push origin my-new-feature)
• Create a new Pull Request

We'll review the Pull Request and comment on it.