{"id":21262917,"url":"https://github.com/stackql/stackql-registry-docs","last_synced_at":"2025-10-19T21:22:30.688Z","repository":{"id":63259346,"uuid":"566164202","full_name":"stackql/stackql-registry-docs","owner":"stackql","description":"StackQL provider documentation for cloud and SaaS providers available in the StackQL Provider Registry, built with Docusaurus.","archived":false,"fork":false,"pushed_at":"2024-10-18T06:10:13.000Z","size":74525,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-18T11:24:55.346Z","etag":null,"topics":["cloud","cloudprovider","documentation","docusaurus","netlify","openapi","openapi3","saas","sql","stackql"],"latest_commit_sha":null,"homepage":"https://registry.stackql.io/","language":"CSS","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/stackql.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}},"created_at":"2022-11-15T04:58:21.000Z","updated_at":"2024-10-18T06:10:17.000Z","dependencies_parsed_at":"2024-10-20T15:03:43.252Z","dependency_job_id":null,"html_url":"https://github.com/stackql/stackql-registry-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-registry-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-registry-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-registry-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-registry-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackql","download_url":"https://codeload.github.com/stackql/stackql-registry-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225674897,"owners_count":17506272,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["cloud","cloudprovider","documentation","docusaurus","netlify","openapi","openapi3","saas","sql","stackql"],"created_at":"2024-11-21T04:59:43.638Z","updated_at":"2025-10-19T21:22:27.908Z","avatar_url":"https://github.com/stackql.png","language":"CSS","readme":"# stackql-registry-docs\n\nThis repository contains documentation for StackQL providers, which is published to [registry.stackql.io](https://registry.stackql.io).  This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.  \n\n## Build and Deploy Status\n\n| Type | Status | Link |\n| --- | --- | -- |\n| GitHub Actions Build | [![GitHub Actions](https://github.com/stackql/stackql-registry-docs/actions/workflows/build-docs.yaml/badge.svg?branch=main)](https://github.com/stackql/stackql-registry-docs/actions/workflows/build-docs.yaml) | [stackql-registry-docs/actions](https://github.com/stackql/stackql-registry-docs/actions) |\n| Netlify Deploy Base | [![Netlify Status](https://api.netlify.com/api/v1/badges/75f838a9-79ea-41dc-96f9-a40dff50cfca/deploy-status)](https://app.netlify.com/sites/stackql-registry-docs/deploys) | [registry.stackql.io](https://registry.stackql.io) |\n| Netlify Deploy AWS | [![Netlify Status](https://api.netlify.com/api/v1/badges/ef161c4a-63ea-4bcc-a5cb-5eaed30ed55f/deploy-status)](https://app.netlify.com/sites/stackql-aws-docs/deploys) | [aws-docs.stackql.io](https://aws-docs.stackql.io)\u003cbr/\u003e[aws.stackql.io](https://aws.stackql.io) |\n| Netlify Deploy Azure | [![Netlify Status](https://api.netlify.com/api/v1/badges/5e2cce2d-3c51-44df-bb14-4ee9c626ca02/deploy-status)](https://app.netlify.com/sites/stackql-azure-docs/deploys) | [azure-docs.stackql.io](https://azure-docs.stackql.io)\u003cbr/\u003e[azure.stackql.io](https://azure.stackql.io) |\n| Netlify Deploy Azure Extras | [![Netlify Status](https://api.netlify.com/api/v1/badges/218dfc50-e1ef-4742-bd95-199c67f4ea95/deploy-status)](https://app.netlify.com/sites/stackql-azure-extras-docs/deploys) | [azure-extras-docs.stackql.io](https://azure-extras-docs.stackql.io)\u003cbr/\u003e[azure-extras.stackql.io](https://azure-extras.stackql.io) |\n| Netlify Deploy Firebase | [![Netlify Status](https://api.netlify.com/api/v1/badges/6d8fec42-fba2-4d62-afef-30a821863314/deploy-status)](https://app.netlify.com/sites/stackql-firebase-docs/deploys) | [firebase-docs.stackql.io](https://firebase-docs.stackql.io)\u003cbr/\u003e[firebase.stackql.io](https://firebase.stackql.io) |  \n| Netlify Deploy GitHub | [![Netlify Status](https://api.netlify.com/api/v1/badges/625d7d38-37a9-4224-a9c8-6ee58141b109/deploy-status)](https://app.netlify.com/sites/stackql-github-docs/deploys) | [github-docs.stackql.io](https://github-docs.stackql.io)\u003cbr/\u003e[github.stackql.io](https://github.stackql.io) |\n| Netlify Deploy Google | [![Netlify Status](https://api.netlify.com/api/v1/badges/028e0d31-604b-4852-8b9b-77a71ead6b93/deploy-status)](https://app.netlify.com/sites/stackql-google-docs/deploys) | [google-docs.stackql.io](https://google-docs.stackql.io)\u003cbr/\u003e[google.stackql.io](https://google.stackql.io) |\n| Netlify Deploy K8S | [![Netlify Status](https://api.netlify.com/api/v1/badges/d11ea6c5-7a43-42d5-ac76-555112295b9b/deploy-status)](https://app.netlify.com/sites/stackql-k8s-docs/deploys) | [k8s-docs.stackql.io](https://k8s-docs.stackql.io)\u003cbr/\u003e[k8s.stackql.io](https://k8s.stackql.io) |\n| Netlify Deploy Netlify | [![Netlify Status](https://api.netlify.com/api/v1/badges/7d81e59f-e1de-480f-a6d5-5a52f83deb40/deploy-status)](https://app.netlify.com/sites/stackql-netlify-docs/deploys) | [netlify-docs.stackql.io](https://netlify-docs.stackql.io)\u003cbr/\u003e[netlify.stackql.io](https://netlify.stackql.io) |\n| Netlify Deploy Okta | [![Netlify Status](https://api.netlify.com/api/v1/badges/83d3788d-bbcf-4063-a2e7-65577e3f13f5/deploy-status)](https://app.netlify.com/sites/stackql-okta-docs/deploys) | [okta-docs.stackql.io](https://okta-docs.stackql.io)\u003cbr/\u003e[okta.stackql.io](https://okta.stackql.io) |\n| Netlify Deploy Sumologic | [![Netlify Status](https://api.netlify.com/api/v1/badges/6c864774-8494-41be-8e2c-441b6d1e368c/deploy-status)](https://app.netlify.com/sites/stackql-sumologic-docs/deploys) | [sumologic-docs.stackql.io](https://sumologic-docs.stackql.io)\u003cbr/\u003e[sumologic.stackql.io](https://sumologic.stackql.io) |\n| Netlify Deploy Digital Ocean | [![Netlify Status](https://api.netlify.com/api/v1/badges/ebcab4ef-d610-4888-a42f-314942d68c32/deploy-status)](https://app.netlify.com/sites/stackql-digitalocean-docs/deploys) | [digitalocean-docs.stackql.io](https://digitalocean-docs.stackql.io)\u003cbr/\u003e[digitalocean.stackql.io](https://digitalocean.stackql.io) |\n| Netlify Deploy Linode | [![Netlify Status](https://api.netlify.com/api/v1/badges/d0b573be-3dfb-495c-a0ce-478ec7acecd8/deploy-status)](https://app.netlify.com/sites/stackql-linode-docs/deploys) | [linode-docs.stackql.io](https://linode-docs.stackql.io)\u003cbr/\u003e[linode.stackql.io](https://linode.stackql.io) |\n| Netlify Deploy Vercel | [![Netlify Status](https://api.netlify.com/api/v1/badges/91cc31b7-0c25-443f-bb2f-71921ef7084e/deploy-status)](https://app.netlify.com/sites/stackql-vercel-docs/deploys) | [vercel-docs.stackql.io](https://vercel-docs.stackql.io)\u003cbr/\u003e[vercel.stackql.io](https://vercel.stackql.io) |\n| Netlify Deploy Godaddy | [![Netlify Status](https://api.netlify.com/api/v1/badges/8232458e-8e4f-47f2-81bf-bd4aad8b25d6/deploy-status)](https://app.netlify.com/sites/stackql-godaddy-docs/deploys) | [godaddy-docs.stackql.io](https://godaddy-docs.stackql.io)\u003cbr/\u003e[godaddy.stackql.io](https://godaddy.stackql.io) |\n| Netlify Deploy PagerDuty | [![Netlify Status](https://api.netlify.com/api/v1/badges/76c8752a-32d8-48e2-81ad-29b9e8f53edd/deploy-status)](https://app.netlify.com/sites/stackql-pagerduty-docs/deploys) | [pagerduty-docs.stackql.io](https://pagerduty-docs.stackql.io)\u003cbr/\u003e[pagerduty.stackql.io](https://pagerduty.stackql.io) |\n| Netlify Deploy Homebrew | [![Netlify Status](https://api.netlify.com/api/v1/badges/2343d34d-5061-4d83-98e6-475fb2150c94/deploy-status)](https://app.netlify.com/sites/stackql-homebrew-docs/deploys) | [homebrew-docs.stackql.io](https://homebrew-docs.stackql.io)\u003cbr/\u003e[homebrew.stackql.io](https://homebrew.stackql.io) |\n| Netlify Deploy Datadog | [![Netlify Status](https://api.netlify.com/api/v1/badges/9e76122d-09bd-4938-a50f-3b4196e94f0c/deploy-status)](https://app.netlify.com/sites/stackql-datadog-docs/deploys) | [datadog-docs.stackql.io](https://datadog-docs.stackql.io)\u003cbr/\u003e[datadog.stackql.io](https://datadog.stackql.io) |\n| Netlify Deploy Azure ISV | [![Netlify Status](https://api.netlify.com/api/v1/badges/35fc840c-0494-462f-9b3f-cbd3418a3c78/deploy-status)](https://app.netlify.com/sites/stackql-azure-isv-docs/deploys) | [azure-isv-docs.stackql.io](https://azure-isv-docs.stackql.io)\u003cbr/\u003e[azure-isv.stackql.io](https://azure-isv.stackql.io) |\n| Netlify Deploy Azure Stack | [![Netlify Status](https://api.netlify.com/api/v1/badges/53abcb20-0194-41dd-b466-4d933cfffcad/deploy-status)](https://app.netlify.com/sites/stackql-azure-stack-docs/deploys) | [azure-stack-docs.stackql.io](https://azure-stack-docs.stackql.io)\u003cbr/\u003e[azure-stack.stackql.io](https://azure-stack.stackql.io) |\n| Netlify Deploy OpenAI | [![Netlify Status](https://api.netlify.com/api/v1/badges/6df5743b-8c5d-4949-866e-eda4ca3f74d0/deploy-status)](https://app.netlify.com/sites/stackql-openai-docs/deploys) | [openai-docs.stackql.io](https://openai-docs.stackql.io)\u003cbr/\u003e[openai.stackql.io](https://openai.stackql.io) |\n| Netlify Deploy Anthropic | [![Netlify Status](https://api.netlify.com/api/v1/badges/114c5a2a-9b76-4941-a0e8-3669ee7d2016/deploy-status)](https://app.netlify.com/sites/stackql-anthropic-docs/deploys) | [anthropic-docs.stackql.io](https://anthropic-docs.stackql.io)\u003cbr/\u003e[anthropic.stackql.io](https://anthropic.stackql.io) |\n| Netlify Deploy Confluent | [![Netlify Status](https://api.netlify.com/api/v1/badges/63149c2f-6c3d-43f1-be38-80c55c223ac0/deploy-status)](https://app.netlify.com/sites/stackql-confluent-docs/deploys) | [confluent-docs.stackql.io](https://confluent-docs.stackql.io)\u003cbr/\u003e[confluent.stackql.io](https://confluent.stackql.io) |\n\n## Adding Docs for a New Provider\n\nAdding docs for a new provider requires creating a new web property (subdomain) and will force an update to the root/base site and all other providers.  The steps are:  \n\n- [ ] update `scripts/docgen/provider_data.py` with metadata for new provider\n- [ ] generate docs for provider using `cd scripts; sh docgen.sh {provider}`\n- [ ] publish docs for provider using `cd scripts; sh publish.sh {provider}`\n- [x] add the new provider docs to `docs/{provider}-docs` (following directory structure of existing providers) (done automatically by `scripts/publish.sh`)\n- [x] update frontmatter in the `index.md` at the root of the new providers docs, set `slug` to `/providers/{provider}` and `id` to `{provider}-doc` (done automatically by `scripts/docgen.sh`)\n- [x] update `stackql-provider-registry.mdx` in the root of the new provider to add the `currentProvider` prop, e.g. `\u003cRegistryPage currentProvider=\"okta\" /\u003e` (done automatically by `scripts/docgen.sh`)\n- [ ] create a new netlify site (`stackql-{provider}-docs`) - use `yarn build:{provider}` as the `build command`\n- [ ] stop automatic builds for site in Netlify\n- [ ] add `NETLIFY` record in Netlify DNS (mapping `{provider}-docs.stackql.io` (Primary Domain) and `{provider}.stackql.io` (Domain Alias) to `stackql-{provider}-docs.netlify.app`), select `Force HTTPS`\n- [ ] add GitHub Actions secret for netlify site id - `NETLIFY_SITE_ID_{PROVIDER}`\n- [ ] add the Netlify deploy status badge to the table in this `README` (see above)\n- [ ] update the `providers` array in `sidebars.js` with the new provider\n- [ ] update the `providers` array `src/configs/providers.ts` with the new provider\n- [ ] update `package.json` with new `start` and `build` scripts\n- [ ] update `allProviders` in `ci-scripts/get-providers-to-deploy.js` with the new provider\n- [ ] add the root site redirects for provider vanity urls to `.github/workflows/build-docs.yaml` to the `add redirects to root site` step of the `deploy-to-netlify` job\n\n## Updating Existing Provider Docs\n\nTo update the docs for an existing provider, edit the corresponding markdown file or files in the `{provider}-docs` directory.  Raise a pull request into the `main` branch.  Once merged, the updated docs will be automatically published.  \n\n### Running Locally\n\nInstall packages:  \n\n```bash\nyarn\n```\n\nTo build a microsite locally, use `yarn build:{provider}`.  For example, to build the AWS microsite locally, run:\n\n```\nexport NODE_OPTIONS=--max_old_space_size=4096\nyarn run build:aws\n```\n\nTo run a microsite locally, use `yarn start:{provider}`.  For example, to run the AWS microsite locally, run:  \n\n```bash\nyarn start:aws\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackql%2Fstackql-registry-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackql%2Fstackql-registry-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackql%2Fstackql-registry-docs/lists"}