cartodb4/carto.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
zhongjin
2020-06-13 18:34:34 +08:00
commit 52aaa9f15d
655 changed files with 96796 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/support/01-support-options.md Normal file
View File

@@ -0,0 +1,38 @@
## Support Options
Feeling stuck? There are many ways to find help.
* Ask a question on [GIS StackExchange](https://gis.stackexchange.com/questions/tagged/carto) using the `CARTO` tag.
* [Report an issue](https://github.com/CartoDB/carto.js/issues) in Github.
* Enterprise Plan customers have additional access to enterprise-level support through CARTO's support representatives.
If you just want to describe an issue or share an idea, just <a class="typeform-share" href="https://cartohq.typeform.com/to/mH6RRl" data-mode="popup" target="_blank"> send your feedback</a><script>(function() { var qs,js,q,s,d=document, gi=d.getElementById, ce=d.createElement, gt=d.getElementsByTagName, id="typef_orm_share", b="https://embed.typeform.com/"; if(!gi.call(d,id)){ js=ce.call(d,"script"); js.id=id; js.src=b+"embed.js"; q=gt.call(d,"script")[0]; q.parentNode.insertBefore(js,q) } })() </script>.
### Issues on Github
If you think you may have found a bug, or if you have a feature request that you would like to share with the CARTO.js team, please [open an issue](https://github.com/cartodb/carto.js/issues/new).
Before opening an issue, review the [contributing guidelines](https://github.com/CartoDB/carto.js/blob/develop/CONTRIBUTING.md#filling-a-ticket).
### Community support on GIS Stack Exchange
GIS Stack Exchange is the most popular community in the geospatial industry. This is a collaboratively-edited question and answer site for geospatial programmers and technicians. It is a fantastic resource for asking technical questions about developing and maintaining your application.
Members of the CARTO.js team regularly monitor the `carto` tag. You can look for CARTO topics by adding `carto` or `carto.js` to your search query. You can also add additional tags to your question in order to attract the attention of experts in related technologies.
When posting a new question, please consider the following:
* Read the GIS Stack Exchange [help](https://gis.stackexchange.com/help) and [how to ask](https://gis.stackexchange.com/help/how-to-ask) pages for guidelines and tips about posting questions.
* Be very clear about your question in the subject. A clear explanation helps those trying to answer your question, as well as those who may be looking for information in the future.
* Be informative in your post. Details, code snippets, logs, screenshots, etc. help others to understand your problem.
* Use code that demonstrates the problem. It is very hard to debug errors without sample code to reproduce the problem.
### Enterprise Plan Customers
Enterprise Plan customers have additional support options beyond general community support. As per your account Terms of Service, you have access to enterprise-level support through CARTO's support representatives available at [enterprise-support@carto.com](mailto:enterprise-support@carto.com)
In order to speed up the resolution of your issue, provide as much information as possible (even if it is a link from community support). This allows our engineers to investigate your problem as soon as possible.
If you are not yet CARTO customer, browse our [plans & pricing](https://carto.com/pricing/) and find the right plan for you.

51
docs/support/02-faq.md Normal file
View File

@@ -0,0 +1,51 @@
## FAQs
CARTO.js v4 introduces new concepts that in some cases, change the behavior of old components. This section clarifies those changes and describe new functionality.
### Do I need an API Key?
Yes. See the guide _[Get API Key]({{site.cartojs_docs}}/guides/get-api-key/)_ or the [full reference API]({{site.cartojs_docs}}/reference/#authentication) for details.
If you want to learn more about authorization and authentication in the CARTO Platform, read the [fundamentals]({{site.fundamental_docs}}/authorization/) about this topic, or dig into the [Auth API]({{site.authapi_docs}}/) details.
### How do I pay for my API Keys?
All billing is managed through your CARTO account.
The release of the updated CARTO.js library does not impact your plan in any way. There are no changes in terms of costs or payments of your CARTO use.
### What are the main features of this release?
This new library allows you to create custom Location Intelligence applications using Builder capabilities.
Highlights of this release include the ability to:
1. Display data from datasets managed in Builder on a Leaflet map.
2. Manage layers programmatically.
3. Get data from CARTO to create custom UI components using Dataviews.
You can learn more about these main features reading the [final release announcement]({{site.cartojs_docs}}/support/release-announcement/).
### Where's the repository now?
The repo has been renamed and moved to https://github.com/CartoDB/carto.js.
### Does CARTO.js support Named Maps?
No.
Named Maps was a powerful and popular feature yet not easy to understand. Named maps were designed as a workaround for some of the limitations of our API keys. Named maps' purpose might be replicated by the new authorization system.
### Can I still use `cartodb.createVis` and `viz.json` URLs?
No, you cannot.
While `cartodb.createVis` and `viz.json` URLs were convenient and allowed you to prototype a map using CARTO Editor (the former version of Builder) to create a custom app, the functionality of the library has changed.
In CARTO.js v4, we are taking a more programmatic, low-level approach and identifying components that are separate from the front-end tool (CARTO Builder). This will make the API easier to use and more intuitive, giving developers greater flexibility in maintaining their core application.
### Is CartoDB.js v.3.15 still available?
Yes.
Both the [source code](https://github.com/CartoDB/carto.js/tree/v3.15.14) and the [documentation](https://carto.com/docs/carto-engine/carto-js/) are still available.

372
docs/support/03-error-messages.md Normal file
View File

@@ -0,0 +1,372 @@
## Errors
CARTO.js emits error objects when something goes wrong. Errors appear in your developer console if not caught. The error object has a code and a description to help you identify the problem and troubleshoot.
### CARTO.js API Error Codes
If you encounter an error while loading CARTO.js, the following table contains a list of known errors codes and possible solutions.
<table id="errors-table" class="paramsTable u-vspace--24">
<thead>
<tr>
<th class="error"><h5 class="title is-small is-regular">Error Code</h5></th>
<th class="message"><h5 class="title is-small is-regular">Message</h5></th>
</tr>
</thead>
<tbody>
<tr>
<td class="tdParams error"><span class="params">api-key-required</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">apiKey property is required.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">api-key-string</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">apiKey property must be a string.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">username-required</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">username property is required.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">username-string</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">username property must be a string.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">non-valid-server-url</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">serverUrl is not a valid URL.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">non-matching-server-url</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">serverUrl doesn't match the username.</p>
</td>
</tr>
</tbody>
</table>
### CARTO.js Error Codes
If you find a validation error on Chrome JavaScript Console, Firefox Web Console, or any other equivalent tools in your browser, please reference the tables below to find explanations for the validation errors. Each table gives specific error information for the different components of CARTO.js.
### Dataview
<table id="errors-table" class="paramsTable u-vspace--24">
<thead>
<tr>
<th class="error"><h5 class="title is-small is-regular">Error Code</h5></th>
<th class="message"><h5 class="title is-small is-regular">Message</h5></th>
</tr>
</thead>
<tbody>
<tr>
<td class="tdParams error"><span class="params">source-required</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Source property is required.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">column-required</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Column property is required.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">column-string</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Column property must be a string.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">empty-column</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Column property must be not empty.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">filter-required</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Filter property is required.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">time-series-options-required</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Options object to create a time series dataview is required.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">time-series-invalid-aggregation</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Time aggregation must be a valid value. Use carto.dataview.timeAggregation.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">time-series-invalid-offset</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Offset must an integer value between -12 and 14.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">time-series-invalid-uselocaltimezone</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">useLocalTimezone must be a boolean value.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">histogram-options-required</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Options object to create a histogram dataview is required.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">histogram-invalid-bins</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Bins must be a positive integer value.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">formula-options-required</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Formula dataview options are not defined.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">formula-invalid-operation</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Operation for formula dataview is not valid. Use carto.operation.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">category-options-required</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Category dataview options are not defined.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">category-limit-required</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Limit for category dataview is required.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">category-limit-number</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Limit for category dataview must be a number.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">category-limit-positive</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Limit for category dataview must be greater than 0.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">category-invalid-operation</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Operation for category dataview is not valid. Use carto.operation.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">category-operation-required</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Operation column for category dataview is required.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">category-operation-string</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Operation column for category dataview must be a string.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">category-operation-empty</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Operation column for category dataview must be not empty.</p>
</td>
</tr>
</tbody>
</table>
### Filter
<table id="errors-table" class="paramsTable u-vspace--24">
<thead>
<tr>
<th class="error"><h5 class="title is-small is-regular">Error Code</h5></th>
<th class="message"><h5 class="title is-small is-regular">Message</h5></th>
</tr>
</thead>
<tbody>
<tr>
<td class="tdParams error"><span class="params">invalid-bounds-object</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Bounds object is not valid. Use a <code>carto.filter.Bounds object</code>.</p>
</td>
</tr>
</tbody>
</table>
### Layer
<table id="errors-table" class="paramsTable u-vspace--24">
<thead>
<tr>
<th class="error"><h5 class="title is-small is-regular">Error Code</h5></th>
<th class="message"><h5 class="title is-small is-regular">Message</h5></th>
</tr>
</thead>
<tbody>
<tr>
<td class="tdParams error"><span class="params">non-valid-source</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">The given object is not a valid source. See <code>carto.source.Base</code>.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">bad-layer-type</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">The given object is not a layer.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">non-valid-style</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">The given object is not a valid style. See <code>carto.style.Base</code>.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">source-with-different-client</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">A layer can't have a source which belongs to a different client.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">style-with-different-client</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">A layer can't have a style which belongs to a different client.</p>
</td>
</tr>
</tbody>
</table>
### Source
<table id="errors-table" class="paramsTable u-vspace--24">
<thead>
<tr>
<th class="error"><h5 class="title is-small is-regular">Error Code</h5></th>
<th class="message"><h5 class="title is-small is-regular">Message</h5></th>
</tr>
</thead>
<tbody>
<tr>
<td class="tdParams error"><span class="params">query-required</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">SQL Source must have a SQL query.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">query-string</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">SQL Query must be a string.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">no-dataset-name</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Table name is required.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">dataset-string</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Table name must be a string.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">dataset-required</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">Table name must be a string.</p>
</td>
</tr>
</tbody>
</table>
### Style
<table id="errors-table" class="paramsTable u-vspace--24">
<thead>
<tr>
<th class="error"><h5 class="title is-small is-regular">Error Code</h5></th>
<th class="message"><h5 class="title is-small is-regular">Message</h5></th>
</tr>
</thead>
<tbody>
<tr>
<td class="tdParams error"><span class="params">required-css</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">CartoCSS is required.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">css-string</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">CartoCSS must be a string.</p>
</td>
</tr>
</tbody>
</table>
### CARTO.js Platform Error Codes for Developers
If you find an error on Chrome JavaScript Console, Firefox Web Console, or any other equivalent tools on your browsers (regarding platform (aka. backend services)), please reference the table below to find explanations for the error codes.
<table id="errors-table" class="paramsTable u-vspace--24">
<thead>
<tr>
<th class="error"><h5 class="title is-small is-regular">Error Code</h5></th>
<th class="message"><h5 class="title is-small is-regular">Message</h5></th>
<th class="description"><h5 class="title is-small is-regular">Description</h5></th>
</tr>
</thead>
<tbody>
<tr>
<td class="tdParams error"><span class="params">over-platform-limits</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">You are over platform's limits.</p>
</td>
<td class="tdParams description">
<p class="text is-small u-tspace--4">In order to guarantee the performance of those APIs for every user of the CARTO platform and prevent abuse, we have set up some general limitations and restrictions on how they work.</p>
       <p class="text is-small u-tspace--4">Learn about fundamentals of [limits]({{site.fundamental_docs}}/limits/) in CARTO.</p>
</td>
</tr>
<tr>
<td class="tdParams error"><span class="params">generic-limit-error</span></td>
<td class="tdParams message">
<p class="text is-small u-tspace--4">The server is taking too long to respond.</p>
</td>
<td class="tdParams description"><p class="text is-small u-tspace--4">Due to poor conectivity or a temporary error with our servers, we cannot handle your request. Please try again soon.</p></td>
</tr>
</tbody>
</table>
### Checking Errors in your Browser
CARTO.js writes error messages to `window.console` if they are not caught. Please check the developer documentation for your browser in order to understand how you can check it.
If any errors occurred when loading CARTO.js, they appear as one or more lines in the console. You can check the [error codes table](#errors above to find te error in the error message. You can also find the details about the error message in the [Full Reference API]({{site.cartojs_docs}}/reference/).
Ensure that you are using a [supported browser]({{site.cartojs_docs}}/support/browsers/).

15
docs/support/04-browser-support.md Normal file
View File

@@ -0,0 +1,15 @@
## Browser Support
CARTO.js works for the last 2 versions in any modern browser and IE11.
### Desktop Browsers
| ![Chrome](https://camo.githubusercontent.com/6bb46f736c023ca3a96263d88cc30ea94a19bd3f/68747470733a2f2f63646e6a732e636c6f7564666c6172652e636f6d2f616a61782f6c6962732f62726f777365722d6c6f676f732f33392e332e302f617263686976652f6368726f6d655f31322d34382f6368726f6d655f31322d34385f34387834382e706e67) | ![Firefox](https://camo.githubusercontent.com/a2f2aef3a61ac88d31266cc5745c92a0943a51fd/68747470733a2f2f63646e6a732e636c6f7564666c6172652e636f6d2f616a61782f6c6962732f62726f777365722d6c6f676f732f33392e332e302f617263686976652f66697265666f785f312e352d332f66697265666f785f312e352d335f34387834382e706e67) | ![Edge](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/45.10.0/edge/edge_48x48.png) | ![Opera](https://camo.githubusercontent.com/f8b46198612edbe858c531588c179a9a564690cc/68747470733a2f2f63646e6a732e636c6f7564666c6172652e636f6d2f616a61782f6c6962732f62726f777365722d6c6f676f732f33392e332e302f6f706572612f6f706572615f34387834382e706e67) | ![Safari](https://camo.githubusercontent.com/bfd047508bfa78a389415ab494cc8dcc04d94e7d/68747470733a2f2f63646e6a732e636c6f7564666c6172652e636f6d2f616a61782f6c6962732f62726f777365722d6c6f676f732f33392e332e302f7361666172692f7361666172695f34387834382e706e67) | ![IE](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/45.10.0/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png) |
|:-------------:|:-------------:|:-----:|:-------------:|:-----:|:-----:|
| Chrome | Mozilla | Edge | Opera | Safari | IE 11 |
### Mobile Browsers
| ![Chrome](https://camo.githubusercontent.com/6bb46f736c023ca3a96263d88cc30ea94a19bd3f/68747470733a2f2f63646e6a732e636c6f7564666c6172652e636f6d2f616a61782f6c6962732f62726f777365722d6c6f676f732f33392e332e302f617263686976652f6368726f6d655f31322d34382f6368726f6d655f31322d34385f34387834382e706e67) | ![Safari](https://camo.githubusercontent.com/bfd047508bfa78a389415ab494cc8dcc04d94e7d/68747470733a2f2f63646e6a732e636c6f7564666c6172652e636f6d2f616a61782f6c6962732f62726f777365722d6c6f676f732f33392e332e302f7361666172692f7361666172695f34387834382e706e67) | ![Samsung Internet](https://cdnjs.cloudflare.com/ajax/libs/browser-logos/45.10.0/archive/samsung-internet_5/samsung-internet_5_48x48.png) |
|:-------------:|:-------------:|:-------------:|
| Mobile Chrome | Mobile Safari | Samsung Internet |

17
docs/support/05-release-announcement.md Normal file
View File

@@ -0,0 +1,17 @@
## v4 Release Announcement
After several months of hard work, CARTO is very proud to announce the __final release of CARTO.js v4__, which replaces our existing CartoDB.js library. We recognize that you have been anticipating an updated version for some time so before we give you the details, thank you for your patience!
The updated CARTO.js library has been __rebuilt from the ground up__. Case Studies indicated that we could change how we structured the API to make it more intuitive for developers. As a result, we created __a more low-level, programmatic approach__ which makes it easier to use and allows you to create fully customized location intelligence apps.
Some of the key features of the Beta release are:
* __A new way of displaying data__ hosted on your CARTO account, on top of Leaflet and Google Maps maps, in the form of layers.
* __A mechanism for extracting data__ from your CARTO account in predefined ways (eg: a list of categories). This is the same mechanism that Builder uses internally for its powerful widgets. It includes being able to filter this data by a bounding box.
* __A way of getting the metadata__ associated to the styles of a particular layer. For example, you will be able to get the names and colors of the categories for a layer styled using a color scheme.
We know that documentation is critical for any good JS library and used this as an opportunity to begin the redesign of how we provide documentation for all of our CARTO platform. Browse the interactive API documentation for the final release to search for specific CARTO.js methods, arguments, and sample code that can be used to build your applications.
Please use the final release and <a class="typeform-share" href="https://cartohq.typeform.com/to/mH6RRl" data-mode="popup" target="_blank">let us know what you think!</a><script>(function() { var qs,js,q,s,d=document, gi=d.getElementById, ce=d.createElement, gt=d.getElementsByTagName, id="typef_orm_share", b="https://embed.typeform.com/"; if(!gi.call(d,id)){ js=ce.call(d,"script"); js.id=id; js.src=b+"embed.js"; q=gt.call(d,"script")[0]; q.parentNode.insertBefore(js,q) } })() </script> The goal is to gather as much feedback as possible so that we can ensure CARTO.js v4 is rock-solid and super useful for all CARTO users. You can find different [support-options]({{site.cartojs_docs}}/support) if you need help.
__Happy coding!__

36
docs/support/06-contribute.md Normal file
View File

@@ -0,0 +1,36 @@
## Contribute
CARTO platform is an open-source ecosystem. You can read about the [fundamentals]({{site.fundamental_docs}}/components/) of CARTO architecture and its components.
We are more than happy to receive your contributions to the code and the documentation as well.
## Filling a ticket
If you want to open a new issue in our repository, please follow these instructions:
1. Descriptive title.
2. Write a good description, it always helps.
3. Include your browser, OS and CARTO.js version (it shows up in the browser console).
4. Specify the steps to reproduce the problem.
5. Try to add an example showing the problem (using [JSFiddle](http://jsfiddle.net), [JSBin](http://jsbin.com),...).
## Contributing code
Best part of open source, collaborate in CARTO.js code!. We like hearing from you, so if you have any bug fixed, or a new feature ready to be merged, those are the steps you should follow:
1. Fork the CARTO.js repository.
2. Create a new branch in your forked repository.
3. Commit your changes. Add new tests if it is necessary (```grunt test```), remember to follow ["How to build"](https://github.com/CartoDB/carto.js/blob/master/README.md#how-to-build) steps.
4. Open a pull request.
5. Any of the CARTO.js mantainers will take a look.
6. If everything works, it will merged and released \o/.
If you want more detailed information, this [GitHub guide](https://guides.github.com/activities/contributing-to-open-source/) is a must.
## Completing documentation
CARTO.js documentation is located in ```docs/```. That folder is the content that appears in the [Developer Center](http://carto.com/developer-center/carto-js/).
Just follow the instructions described in [contributing code](#contributing-code) and after accepting your pull request, we will make it appear online :).
## Submitting contributions
You will need to sign a Contributor License Agreement (CLA) before making a submission. [Learn more here](https://carto.com/contributions).