Website

This is the Curling IO landing page and documentation site.

Installation

Git

Before you can begin writing documentation you'll need git installed. You can do this from your terminal (preferred) or by using github's desktop GUI found here: https://desktop.github.com/

For OSX if you don't have homebrew (https://brew.sh/) installed, you can install it first with the following in your terminal:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

From the terminal on OSX once you have homebrew installed:

brew install git

If you're using a debian based Linux shell:

sudo apt-get install git

Nodejs

Make sure you have nodejs installed on your machine. The easiest (and most flexible) way to do this on a Mac or Linux based operating system is using asdf (https://asdf-vm.com/). Once asdf is installed, open up a terminal (osx) or shell (linux) and run the following:

asdf install nodejs 16.5.0

Then in your terminal / shell, cd into the project directory and install the libraries that this project uses:

Project Dependencies

cd curlingio-docs
npm install -g yarn
yarn install

Local Development

Once you have everything installed and setup locally, you can run a local preview environment by running the following in your terminal or shell:

yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Search Configuration

DocSearch is available when the following environment variables are present before running yarn start or yarn build:

• ALGOLIA_SEARCH_API_KEY: search-only key (defaults to d4c292bfdc67172d839f0f3a6da64bfb if unset).
• ALGOLIA_APP_ID: defaults to 56JJO2SJ1B if unset.
• ALGOLIA_INDEX_NAME: defaults to the DocSearch index curling if unset.

Set these variables in your shell session or .env file to enable the in-site search widget locally and in CI. Contextual filtering is disabled so searches return matches across the entire documentation set.

Deployment

By pushing your changes to git's master branch, or merging into master from a pull request, changes will be automatically deployed to our production environment using a Github action. It may take a few minutes before changes show up on the live server.