Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ SHELL := bash
.DEFAULT_GOAL := help

PROVIDER := snowflake
SOURCE_PROJECT ?= https://github.com/stackql-registry/stackql-provider-$(PROVIDER)
SERVICES_DIR := provider-dev/openapi/src/$(PROVIDER)
SERVERS := [{"url": "https://{endpoint}.snowflakecomputing.com", "variables": {"endpoint": {"default": "orgname-accountname", "description": "Organization and account identifier (orgname-accountname)"}}}]
PROVIDER_CONFIG := {"auth": {"type": "bearer", "credentialsenvvar": "SNOWFLAKE_PAT"}, "snake_case_aliases": true}
Expand Down Expand Up @@ -89,7 +90,8 @@ docs: ## generate the website docs from the generated provider
--provider-name $(PROVIDER) \
--provider-dir ./$(SERVICES_DIR)/v00.00.00000 \
--output-dir ./website \
--provider-data-dir ./provider-dev/docgen/provider-data
--provider-data-dir ./provider-dev/docgen/provider-data \
--source-project $(SOURCE_PROJECT)
node provider-dev/docgen/sanitize_docs.mjs

website: ## build the docusaurus microsite (vendors shared config first)
Expand Down
4 changes: 3 additions & 1 deletion bin/generate-docs.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ async function generateDocs() {
const providerDir = getArg('--provider-dir');
const outputDir = getArg('--output-dir');
const providerDataDir = getArg('--provider-data-dir');
const sourceProject = getArg('--source-project');

if (!providerName || !providerDir || !outputDir || !providerDataDir) {
console.error('Error: Missing required arguments');
Expand All @@ -31,7 +32,8 @@ async function generateDocs() {
providerName,
providerDir,
outputDir,
providerDataDir
providerDataDir,
sourceProject
});

console.log('Documentation generated successfully:', result);
Expand Down
68 changes: 55 additions & 13 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"dependencies": {
"@apidevtools/swagger-parser": "^12.1.0",
"@stackql/pgwire-lite": "^1.0.1",
"@stackql/provider-utils": "^0.7.7",
"@stackql/provider-utils": "^0.7.12",
"js-yaml": "^5.2.1"
},
"keywords": [
Expand Down
1 change: 1 addition & 0 deletions website/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Cloud data platform - query and provision Snowflake control plane resources (dat

total services: __13__
total resources: __88__
source project: __[stackql-provider-snowflake](https://github.com/stackql-registry/stackql-provider-snowflake)__

:::

Expand Down
13 changes: 13 additions & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@ import { providerTitle } from './provider.js';

const sidebars = {
mainSidebar: [
// Way back to the main stackql.io docs, as on the query library site.
// '/stackqldocs' is a shared-config redirect route (registered on this
// site by the vendored redirects plugin) that forwards to
// https://stackql.io/, so the link renders as internal - no external-link
// icon - and the broken-link checker validates it. The arrow and the
// divider come from the .sidebar-back-link rules in src/css/global.css.
{
type: 'link',
label: 'Back to StackQL Docs',
href: '/stackqldocs',
className: 'sidebar-back-link',
},
// '/providers' is likewise a shared redirect, to https://stackql.io/providers.
{ type: 'link', label: 'All Providers', href: '/providers' },
{
type: 'category',
Expand Down
22 changes: 21 additions & 1 deletion website/src/css/global.css
Original file line number Diff line number Diff line change
Expand Up @@ -284,4 +284,24 @@ div:has(> .vhsImage) {
.navbar__logo img[src$='stackql-registry-logo-white.svg'] {
content: url('/img/stackql-registry-logo-white-mobile.svg');
}
}
}

/*
* sidebar: back link to the main stackql.io docs (the first item in
* sidebars.js). Same treatment as the query library site: bold label,
* leading arrow drawn here so the label stays plain text, divider below.
*/
.sidebar-back-link {
border-bottom: 1px solid var(--ifm-color-emphasis-300);
padding-bottom: 0.5rem;
margin-bottom: 0.5rem !important;
}

.sidebar-back-link .menu__link {
font-weight: 600;
}

.sidebar-back-link .menu__link::before {
content: '\2190';
margin-right: 0.5rem;
}
Loading