This repo is created to host CARTO's products documentation. It has the objective to unite both the Dev center and the Help center into one unique and homogeneus place for all our products.
We have created a docker-compose to make it simpler to run. In the terminal, just go to the documentation folder and run the following command
docker-compose up server
This will start the server locally and you can see the page in http://localhost:1313/
You can also build the page and generate the static files running
docker-compose up build
Some projects have external files to be included in the documentation. Those files, generally the reference files, live in the main source code repository.
To checkout the latest changes in the remote repository:
./scripts/checkout.sh
To checkout a certain branch of the documentation:
BRANCH=branch-name ./scripts/checkout.sh
And to review changes to review changes to the docs/ directory in the Analytics Toolbox repo before publishing, use the absolute path to your local folder:
LOCAL_AT_PATH=~/path/to/analytics-toolbox ./scripts/checkout.sh
Once any of these versions is checked out, to update the reference files run:
./scripts/update.sh
To deploy into a preview channel you just need to create a Pull Request. Once the Github Action finishes, it will add a comment with the result and the preview url (the url will be valid for 7 days). Each new commit into the PR, will regenerate the staging page.
⚠️ If you need to access any link in the doc, you need to add your preview URL in the preview file and commit this change.
👉 e.g. run: hugo --baseURL 'https://cartodb-fb-documentation--pr459-testing-preview-m5jwtz81.web.app/'
Once you're happy with the result, simply merge your branch into master and it will do the deploy to production automatically
⚠️ Remember to revert the commit if you have added your preview URL in the preview file before merging.
👉 run: hugo --baseURL .
The process for creating new documentation is documented in this document
This is hosted in firebase, under the project named cartodb-fb-documentation