Skip to content

refactor: consolidate setup/teardown docs to docs site #764

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
saddlepaddle merged 3 commits into from
Jan 15, 2026
Merged

refactor: consolidate setup/teardown docs to docs site #764

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c12734
refactor: consolidate setup/teardown docs to docs site
saddlepaddle Jan 15, 2026
3a084c7
refactor: remove SCRIPTS_URL from shared constants
saddlepaddle Jan 15, 2026
c4566b4
refactor: add EXTERNAL_LINKS constants to desktop app
saddlepaddle Jan 15, 2026
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
1 change: 1 addition & 0 deletions .github/workflows/build-desktop.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ jobs:
GH_CLIENT_ID: ${{ secrets.GH_CLIENT_ID }}
NEXT_PUBLIC_WEB_URL: ${{ secrets.NEXT_PUBLIC_WEB_URL }}
NEXT_PUBLIC_API_URL: ${{ secrets.NEXT_PUBLIC_API_URL }}
NEXT_PUBLIC_DOCS_URL: ${{ secrets.NEXT_PUBLIC_DOCS_URL }}
SENTRY_DSN_DESKTOP: ${{ secrets.SENTRY_DSN_DESKTOP }}
run: bun run compile:app

Expand Down
8 changes: 8 additions & 0 deletions apps/desktop/electron.vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ export default defineConfig({
process.env.NEXT_PUBLIC_WEB_URL,
"https://app.superset.sh",
),
"process.env.NEXT_PUBLIC_DOCS_URL": defineEnv(
process.env.NEXT_PUBLIC_DOCS_URL,
"https://docs.superset.sh",
),
"process.env.GOOGLE_CLIENT_ID": defineEnv(process.env.GOOGLE_CLIENT_ID),
"process.env.GH_CLIENT_ID": defineEnv(process.env.GH_CLIENT_ID),
"process.env.SENTRY_DSN_DESKTOP": defineEnv(
Expand Down Expand Up @@ -120,6 +124,10 @@ export default defineConfig({
process.env.NEXT_PUBLIC_WEB_URL,
"https://app.superset.sh",
),
"process.env.NEXT_PUBLIC_DOCS_URL": defineEnv(
process.env.NEXT_PUBLIC_DOCS_URL,
"https://docs.superset.sh",
),
"import.meta.env.DEV_SERVER_PORT": defineEnv(String(DEV_SERVER_PORT)),
"import.meta.env.NEXT_PUBLIC_POSTHOG_KEY": defineEnv(
process.env.NEXT_PUBLIC_POSTHOG_KEY,
Expand Down
4 changes: 2 additions & 2 deletions apps/desktop/src/renderer/components/ConfigFilePreview/ConfigFilePreview.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { COMPANY } from "@superset/shared/constants";
import { Button } from "@superset/ui/button";
import { cn } from "@superset/ui/utils";
import { HiArrowTopRightOnSquare } from "react-icons/hi2";
Expand All @@ -7,6 +6,7 @@ import { electronTrpc } from "renderer/lib/electron-trpc";
import {
CONFIG_FILE_NAME,
CONFIG_TEMPLATE,
EXTERNAL_LINKS,
PROJECT_SUPERSET_DIR_NAME,
} from "shared/constants";

Expand All @@ -29,7 +29,7 @@ export function ConfigFilePreview({
);

const handleLearnMore = () => {
window.open(COMPANY.SCRIPTS_URL, "_blank");
window.open(EXTERNAL_LINKS.SETUP_TEARDOWN_SCRIPTS, "_blank");
};

const displayContent =
Expand Down
4 changes: 2 additions & 2 deletions apps/desktop/src/renderer/components/SetupConfigModal/SetupConfigModal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { COMPANY } from "@superset/shared/constants";
import { Button } from "@superset/ui/button";
import {
Dialog,
Expand All @@ -15,6 +14,7 @@ import {
useConfigModalOpen,
useConfigModalProjectId,
} from "renderer/stores/config-modal";
import { EXTERNAL_LINKS } from "shared/constants";

const CONFIG_TEMPLATE = `{
"setup": [],
Expand All @@ -40,7 +40,7 @@ export function SetupConfigModal() {
const projectName = project?.name ?? "your-project";

const handleLearnMore = () => {
window.open(COMPANY.SCRIPTS_URL, "_blank");
window.open(EXTERNAL_LINKS.SETUP_TEARDOWN_SCRIPTS, "_blank");
};

return (
Expand Down
5 changes: 5 additions & 0 deletions apps/desktop/src/shared/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,8 @@ export const NOTIFICATION_EVENTS = {
// Default user preference values
export const DEFAULT_CONFIRM_ON_QUIT = true;
export const DEFAULT_TERMINAL_LINK_BEHAVIOR = "external-editor" as const;

// External links (documentation, help resources, etc.)
export const EXTERNAL_LINKS = {
SETUP_TEARDOWN_SCRIPTS: `${process.env.NEXT_PUBLIC_DOCS_URL}/setup-teardown-scripts`,
} as const;
193 changes: 0 additions & 193 deletions apps/marketing/src/app/scripts/page.tsx
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion packages/shared/src/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ export const COMPANY = {
MAIL_TO: "mailto:founders@superset.sh",
REPORT_ISSUE_URL: "https://github.com/superset-sh/superset/issues/new",
DISCORD_URL: "https://discord.gg/cZeD9WYcV7",
SCRIPTS_URL: "https://superset.sh/scripts",
} as const;

// Theme
Expand Down