Circonus Product Documentation Project

This repository generates docs.circonus.com. The associated HTML is generated by processing the contributed markdown files using Docusaurus 2, a modern static website generator.

The following Circonus projects are documented here:

• Circonus 2.0
• IRONdb
• CAQL

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

MacOS

There are a few dependencies to getting this project up and running:

• Node
• Yarn
• Format your markdown files like a pro with prettier.

Using homebrew, install the following prerequisites

brew install node

brew install yarn

Installing

This project can be used as a basic checkout from the GitHub repository. Simply:

git clone https://github.com/circonus/product-docs.git

To generate the associated docs HTML, run yarn start from within the project directory:

yarn start

Example:

➜  product-docs git:(migration-fixes) ✗ pwd
/Users/joshuajohnson/development/product-docs
➜  product-docs git:(migration-fixes) ✗ yarn start
yarn run v1.22.19
$ docusaurus start
[INFO] Starting the development server...
[SUCCESS] Docusaurus website is running at: http://localhost:3000/

✔ Client
  Compiled successfully in 2.08s

client (webpack 5.88.2) compiled successfully

The terminal output will direct you to a URL to view the rendered markdown in a browser.

If you come across any issues, please referance the Docusaurus documentation.

Contributing

To suggest a change to the project, create a dedicated branch. For details regarding the project organization and content formatting, see our Contribution Guidelines.

When you're finished with your work, issue a pull request and assign at least one reviewer from the Circonus team. The reviewer will either approve the pull request or suggest improvements. Once the pull request has been approved, a Circonus team member will merge and delete the branch. For pull requests made by Circonus team members authors will merge and delete their own branches.

Deployment

Approved contributions will be automatically pulled and deployed to docs.circonus.com every few minutes.

Redirects within these docs can be added to ~/product-docs/static/_redirects.

License

This project is licensed under the MIT License - see the license file for details

Original Docusaurus Deployment Instructions

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

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

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.