https://github.com/circonus/product-docs
Documentation for Circonus Products
https://github.com/circonus/product-docs
documentation hacktoberfest monitoring
Last synced: 5 months ago
JSON representation
Documentation for Circonus Products
- Host: GitHub
- URL: https://github.com/circonus/product-docs
- Owner: circonus
- Created: 2023-08-07T17:53:22.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-12-05T20:20:20.000Z (7 months ago)
- Last Synced: 2025-12-09T09:35:51.798Z (7 months ago)
- Topics: documentation, hacktoberfest, monitoring
- Language: JavaScript
- Homepage:
- Size: 83.7 MB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Circonus Product Documentation Project
This repository generates docs.circonus.com. The associated HTML is generated by processing the contributed markdown files using [Docusaurus 2](https://docusaurus.io/), 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](https://formulae.brew.sh/formula/node)
- [Yarn](https://formulae.brew.sh/formula/yarn)
- Format your markdown files like a pro with [prettier](https://github.com/prettier/prettier-vscode).
Using homebrew, install the following prerequisites
```bash
brew install node
```
```bash
brew install yarn
```
#### Installing
This project can be used as a basic checkout from the GitHub repository. Simply:
```bash
git clone https://github.com/circonus/product-docs.git
```
To generate the associated docs HTML, run ```yarn start``` from within the project directory:
```bash
yarn start
```
**Example:**
```bash
➜ 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](https://docusaurus.io/docs/installation) 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](https://docs.circonus.com/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](https://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](LICENSE) file for details
Original Docusaurus Deployment Instructions
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```bash
$ 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:
```bash
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER= 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.