REVIEW.md

Responsive must-haves

• Main menu

• Hide:

  • home menu
  • breadcrumb menu
  • sticky header

• Footer

• Header layout

  • Overview

• Container layout

• Sidebar positioning

Main points

• Add alt images as caption images

• Refactor CARTOFrames slug to cartoframes

• Update CARTOFrames branch to documentation

• Update versions in technologies.yml

• Change 'documentation' references to 'developers'

• Change 'screenshots' to have false API keys

• Change 'tools' reference to 'Styling'

• Create footer

• Hide VL component

• Create dropdown blocks for h3 in data observatory reference

• Fix sticky header

• Fix root path to redirect to the first content

• Talk to Cillas about Data Services API reference. It's a .md file like Torque.js reference.

• Fill examples.json on Data Observatory repo with 3 categories

• Fill examples.json on Torque.js repo

• Complete examples.json on Python SDK repo

• Create layout for examples on python sdk

• Create 'catalog' wording for data observatory: overview and menu

• Create assets for all of the overviews

• Create code snippets for all of the overviews

• Fix colors on reference thirdbar

• Create basic search layout

Release

• URls redirections list

  • Make an URLS.md to list cases

• Infra hosting

  • Change name 'documentation'

• Workflow publishing

  • Set up frequency to 12 hours
  • Trigger manually when needed

• Change repo name

• Create issues for auth system, carto.js and dev center.

  • Order: auth, carto.js, dev center
  • Order: data auth, banner + bell notification, feature flag, carto.js, dev center

• Add link to the new documentation to the existing docs

  • Merge https://github.com/CartoDB/docs/pull/1278
  • Deploy docs to production

UI

• Some kind of smooth behaviour when scrolling through anchor links

• Some kind of basic format for tables

• A basic footer with the main links

CARTO.js ---

• Remove all the references to the internal, alpha, or beta release.

  • Change this on the repo and make a PR.
  • Glossary: ajax,

• Remove all the references to the v4 on the contents.

  • Change this on the repo and make a PR.

• Add assets for guides and api reference on the home.

  • Prepare images.
  • Talk to Cillas to change that.
  • Change the default example on CARTO.js repo and make a PR.

• Add a support section on the home.

  • Talk to Cillas to change that.

• Format properly the glossary and add more entries.

  • Change that on the repo and make a PR.

• Fix typo on the intro of full reference: "read the guides" is duplicated.

  • Change that on the repo and make a PR.

• Review support home and remove images.

  • Change that on the repo and make a PR.

• Review FAQs and updates with the news.

  • Change that on the repo and make a PR.

• Review errors and remove the column description.

  • Change that on the repo and make a PR.

• Review release announcement and adapt to the final release.

  • Change that on the repo and make a PR.

Mobile SDK ---

• Add assets for guides and api reference on the home.

  • Prepare images.
  • Talk to Cillas to change that.
  • Change the default example on CARTO.js repo and make a PR.

• Add a support section on the home.

  • Talk to Cillas to change that.

• Fix guide name "10 clustering"

  • Talk to Cillas to change that.

• Fix guide that goes to 404: http://final-release.documentation.carto-staging.com/documentation/mobile-sdk/guides/keys/

  • Talk to Cillas about that.
  • Review contents in the light of the new auth system.
  • Make a PR.

• Improve the home of reference giving the links to the api references outside the developer center.

  • Make a PR.

• Improve support home page.

  • Make a PR.

Torque.js ---

• Add assets for guides and api reference on the home.

  • Prepare images.
  • Talk to Cillas to change that.
  • Change the default example on CARTO.js repo and make a PR.

• Add a reference section on the home.

  • Talk to Cillas to change that.

• Add a support section on the home.

  • Talk to Cillas to change that.

• Review guides contents

  • Talk to Cillas to change that.

• Create examples from the examples repo:

  • http://final-release.documentation.carto-staging.com/documentation/torque-js/guides/getting-started/#usage-examples

  • Make a PR with that.

• Review CartoCSS guide: making an intro, explaining the methods, etc.

  • http://final-release.documentation.carto-staging.com/documentation/torque-js/guides/CartoCSS/

  • Make a PR.

• Review Torque reference to be included as a reference though it's still a markdown file.

  • Talk to Cillas about that.
  • Make changes on the repo to improve those contents.
  • Make a PR.

• Improve the home support.

  • Make a PR.

Auth API

• Add assets for guides and api reference on the home.

  • Prepare images.
  • Talk to Cillas to change that.
  • Change the default example on CARTO.js repo and make a PR.

• Add a support section on the home.

  • Talk to Cillas to change that.

• Improve intro guide: adding screenshots of auth dashboard, and giving an overal explanation

  • Make a PR.

• Improve guide about types of keys adding screenshot of those as they are being displayed on auth dashboard.

  • Make a PR.

• Improve the general considerations giving it a better format and adding explanations to each point.

  • Make a PR.

• Improve the support home.

  • Make a PR.

SQL API

• Add assets for guides and api reference on the home.

  • Prepare images.
  • Talk to Cillas to change that.
  • Change the default example on CARTO.js repo and make a PR.

• Add a reference section on the home.

  • Talk to Cillas to change that.

• Add a support section on the home.

  • Talk to Cillas to change that.

• Improve intro guide: reviewing links and contents.

  • Make a PR.

• Improve authentication guide, adding references to the new auth system and explaining the basics.

  • Make a PR.

• Review Metrics guide: add an intro, explain what timers are, improve formatting.

  • Make a PR.

• Add a support global home.

  • Make a PR.

• Review tips and tricks.

  • Make a PR.

• Add limits support page.

  • Add contents as Simon wrote those.
  • Make a PR.

Maps API

• Add assets for guides and api reference on the home.

  • Prepare images.
  • Talk to Cillas to change that.
  • Change the default example on CARTO.js repo and make a PR.

• Add a reference section on the home.

  • Talk to Cillas to change that.

• Add a support section on the home.

  • Talk to Cillas to change that.

• Fix name of guide "10 mapconfig dataviews"

  • Talk to Cillas.

• Review General concepts auth.

  • Make a PR.

• Review reference:

  • http://final-release.documentation.carto-staging.com/documentation/maps-api/reference/
  • Talk to Eneko to see if he can finish the work he started making an Open API for this.

• Insert a global support page.

  • Make a PR.

• Review the metrics support page.

  • Add an intro.
  • Improve contents
  • Make a PR.

• Add limits support page.

  • Add contents as Simon wrote those.
  • Make a PR.

Import API

• Why there is no reference on the navbar

  • Talk to Cillas

• Add assets for guides and api reference on the home.

  • Prepare images.
  • Talk to Cillas to change that.
  • Change the default example on CARTO.js repo and make a PR.

• Add a support section on the home.

  • Talk to Cillas to change that.

• Review General concepts auth.

  • Make a PR.

• Insert a global support page.

  • Make a PR.

• Review the import errors support page.

  • Add an intro.
  • Improve contents
  • Make a PR.

Data Services API

• Add assets for guides and api reference on the home.

  • Prepare images.
  • Talk to Cillas to change that.
  • Change the default example on CARTO.js repo and make a PR.

• Add a reference section on the home.

  • Talk to Cillas to change that.

• Add a support section on the home.

  • Talk to Cillas to change that.

• Review General concepts auth.

  • Review auth
  • Review limits and link to new contents
  • Make a PR.

• Review reference:

  • http://final-release.documentation.carto-staging.com/documentation/data-services-api/reference/
  • Talk to Eneko to see if he can finish the work he started making an Open API for this.

• Insert a global support page.

  • Make a PR.

• Review the quota and rate limiting.

  • Link to limits on fundamentals.
  • Add an intro.
  • Improve contents
  • Make a PR.

On-premise

• Add assets for guides.

  • Prepare images.
  • Talk to Cillas to change that.
  • Change the default example on CARTO.js repo and make a PR.

• Add a support section on the home.

  • Talk to Cillas to change that.

• Insert a global support page.

  • Make a PR.

Data observatory

• Add assets for guides.

  • Prepare images.
  • Talk to Cillas to change that.
  • Change the default example on CARTO.js repo and make a PR.

• Add a reference section on the home.

  • Talk to Cillas to change that.

• Add a support section on the home.

  • Talk to Cillas to change that.

• Review catalog format.

  • Talk to Cillas to change that.

Tools ---

• Review turbo carto ---

  • http://final-release.documentation.carto-staging.com/documentation/stylingturbocarto/

  • Make a PR.

• Review cartocss ---

  • http://final-release.documentation.carto-staging.com/documentation/stylingcartocss/

  • Make a PR.

• Review carto color ---

  • http://final-release.documentation.carto-staging.com/documentation/stylingcartocolors/

  • Make a PR.

• Add content for Airship

  • airship repo

  • Make a PR.

• Fix images

  • Images are not being displayed

Python SDK ---

• Index Guide should be the first page of the guides section:

  http://final-release.documentation.carto-staging.com/documentation/python-sdk/guides/index/

  • Talk to Cillas to change that.

• Quickstart guide should be the second one.

  http://final-release.documentation.carto-staging.com/documentation/python-sdk/guides/quickstart/

  • Talk to Cillas to change that.

• Installation one should be the third one, and general concepts the fourth.

  • Talk to Cillas to change that.

• The wording 'carto-python' should be converted to 'Python SDK' on the sources.

  • Change this on the repo and make a PR.

• The 'note', 'tip', 'warning' blocks should be formatted properly on the sources.

  • Change this on the repo and make a PR.

• The guide 'Examples' should be converted to a list of examples into the repo.

  • Change this on the repo and make a PR.

• The code blocks should be formatted as Python code on the sources.

  • Change this on the repo and make a PR.

• There are some names of guides that are being displayed with underscore as '_'.

  • Talk to Cillas to change that.

• Add a support section in the repo.

  • Change this on the repo and make a PR.

• Add assets for guides and examples on the home.

  • Prepare images.
  • Talk to Cillas to change that.