{"id":42110155,"url":"https://github.com/circonus/product-docs","last_synced_at":"2026-01-26T13:33:23.669Z","repository":{"id":186800019,"uuid":"675781471","full_name":"circonus/product-docs","owner":"circonus","description":"Documentation for Circonus Products","archived":false,"fork":false,"pushed_at":"2025-12-05T20:20:20.000Z","size":87741,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-12-09T09:35:51.798Z","etag":null,"topics":["documentation","hacktoberfest","monitoring"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/circonus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-08-07T17:53:22.000Z","updated_at":"2025-12-05T20:20:23.000Z","dependencies_parsed_at":"2024-12-17T21:22:50.194Z","dependency_job_id":"7cd2553b-2452-4c8b-b849-e998b71b16ee","html_url":"https://github.com/circonus/product-docs","commit_stats":{"total_commits":132,"total_committers":6,"mean_commits":22.0,"dds":0.5075757575757576,"last_synced_commit":"fa451b61de4c30e857af55a097d70daaa2d997a4"},"previous_names":["circonus/product-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/circonus/product-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circonus%2Fproduct-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circonus%2Fproduct-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circonus%2Fproduct-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circonus%2Fproduct-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/circonus","download_url":"https://codeload.github.com/circonus/product-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circonus%2Fproduct-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28779341,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T11:46:04.308Z","status":"ssl_error","status_checked_at":"2026-01-26T11:46:02.664Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","hacktoberfest","monitoring"],"created_at":"2026-01-26T13:33:23.597Z","updated_at":"2026-01-26T13:33:23.659Z","avatar_url":"https://github.com/circonus.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Circonus Product Documentation Project\n\nThis 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.\n\nThe following Circonus projects are documented here:\n\n- Circonus 2.0\n- IRONdb\n- CAQL\n\n## Getting Started\n\nThese 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.\n\n### MacOS\n\nThere are a few dependencies to getting this project up and running:\n\n- [Node](https://formulae.brew.sh/formula/node)\n- [Yarn](https://formulae.brew.sh/formula/yarn)\n- Format your markdown files like a pro with [prettier](https://github.com/prettier/prettier-vscode).\n\nUsing homebrew, install the following prerequisites\n\n```bash\nbrew install node\n```\n\n```bash\nbrew install yarn\n```\n\n#### Installing\n\nThis project can be used as a basic checkout from the GitHub repository. Simply:\n\n```bash\ngit clone https://github.com/circonus/product-docs.git\n```\n\nTo generate the associated docs HTML, run ```yarn start``` from within the project directory:\n\n```bash\nyarn start\n```\n\n**Example:**\n\n```bash\n➜  product-docs git:(migration-fixes) ✗ pwd\n/Users/joshuajohnson/development/product-docs\n➜  product-docs git:(migration-fixes) ✗ yarn start\nyarn run v1.22.19\n$ docusaurus start\n[INFO] Starting the development server...\n[SUCCESS] Docusaurus website is running at: http://localhost:3000/\n\n✔ Client\n  Compiled successfully in 2.08s\n\nclient (webpack 5.88.2) compiled successfully\n\n```\n\nThe terminal output will direct you to a URL to view the rendered markdown in a browser.\n\nIf you come across any issues, please referance the [Docusaurus](https://docusaurus.io/docs/installation) documentation.\n\n## Contributing\n\nTo suggest a change to the project, create a dedicated branch. For details regarding the project organization and content formatting, see our\n[Contribution Guidelines](https://docs.circonus.com/contribution-guidelines/).\n\nWhen 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\nsuggest 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\nauthors will merge and delete their own branches.\n\n## Deployment\n\nApproved contributions will be automatically pulled and deployed to [docs.circonus.com](https://docs.circonus.com/) every few minutes.\n\nRedirects within these docs can be added to `~/product-docs/static/_redirects`.\n\n## License\n\nThis project is licensed under the MIT License - see the [license](LICENSE) file for details\n\n\u003cdetails\u003e\u003csummary\u003eOriginal Docusaurus Deployment Instructions\u003c/summary\u003e\n\u003cp\u003e\n\n# Website\n\nThis website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.\n\n### Installation\n\n```bash\n$ yarn\n```\n\n### Local Development\n\n```\n$ yarn start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n### Build\n\n```\n$ yarn build\n```\n\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\n\n### Deployment\n\nUsing SSH:\n\n```bash\n$ USE_SSH=true yarn deploy\n```\n\nNot using SSH:\n\n```\n$ GIT_USER=\u003cYour GitHub username\u003e yarn deploy\n```\n\nIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.\n\n\u003c/p\u003e\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirconus%2Fproduct-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcirconus%2Fproduct-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirconus%2Fproduct-docs/lists"}