New docs folder for developer center

CartoDB / torque

Temporal mapping for CARTO

http://cartodb.github.com/torque/

BSD 4-Clause "Original" or "Old" License

397 stars 129 forks source link

New docs folder for developer center #291

Closed csubira closed 5 years ago

csubira commented 6 years ago

The new documentation folder (docs) is created to meet the requirements of the new developer center.

At the moment, docs folder contains four folders or categories (guides, reference, examples and support). To start, each of them is filled with older information (usually contained in doc folder).

In this first step, using this branch, the new workflow of documentation repository (for importing and displaying content) is going to be tested.

Once validated, the second step is to get your validation @ivanmalagon about content (correcting current information or adding new items)

csubira commented 5 years ago

This PR has been updated to remove old documentation (used in carto.com/docs, now deprecated and redirected to Developer Center) The outcome of this changes is already in production, as this branch was the one connected to Developer Center, the only change would me merging this folder to master so it can be updated when developing. https://github.com/CartoDB/developers/issues/537

VictorVelarde commented 5 years ago

Hi @csubira I have some doubts regarding to the examples

There are currently 2 folders: /examples and /docs/examples. The one that's currently being used at dev-center is the first one, and I guess that the second one will be the new one. But right now, they are not equal. There are more examples in the 'old one' and some, like 'car', just appear in the second (which only has 4). I guess we should review and merge both sets

csubira commented 5 years ago

Yes! You are right @VictorVelarde , so here there are the last changes I made:

Moved examples folder from source to docs folder
Remove misc folder since the *.md files included are already duplicated in guides.
Replace vendor/leaflet imports in examples since it was donde before to examples that were updated to be published -> then delete vendor folder.
Changed in developers repository the new origin of examples
Check that the examples show properly in production https://carto.com/developers/torque-js/examples/

VictorVelarde commented 5 years ago

Nice work @csubira 👍 I just made a little change to examples 'categories' but IMO it's ready to be merged