Skip to content

Commit f2c112e

Browse files
authored
chore(docs): point docs links to developers.databricks.com (#463)
Replace DevHub doc URLs (www.databricks.com/devhub/docs/appkit/v0) with developers.databricks.com/docs/appkit/v0 across the README, app template, SDK jsdoc, and the docs redirect tooling. Also update the adjacent DevHub branding (DEVHUB_BASE -> DOCS_BASE, comments, and prose) so the docs stay consistent. The CI devhub-validation job is left as-is; it clones the github.com/databricks/devhub build repo, not a published link. Signed-off-by: Pawel Kosiec <pawel.kosiec@databricks.com>
1 parent 9cdb42d commit f2c112e

7 files changed

Lines changed: 20 additions & 19 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ AppKit's power comes from its plugin system. Each plugin adds a focused capabili
2727
2828
## Getting started
2929

30-
Follow the [Getting Started](https://www.databricks.com/devhub/docs/appkit/v0/) guide to get started with AppKit.
30+
Follow the [Getting Started](https://developers.databricks.com/docs/appkit/v0/) guide to get started with AppKit.
3131

32-
🤖 For AI/code assistants, see the [AI-assisted development](https://www.databricks.com/devhub/docs/appkit/v0/development/ai-assisted-development) guide.
32+
🤖 For AI/code assistants, see the [AI-assisted development](https://developers.databricks.com/docs/appkit/v0/development/ai-assisted-development) guide.
3333

3434
## Documentation
3535

36-
📖 For full AppKit documentation, visit the [AppKit Documentation](https://www.databricks.com/devhub/docs/appkit/v0/) website.
36+
📖 For full AppKit documentation, visit the [AppKit Documentation](https://developers.databricks.com/docs/appkit/v0/) website.
3737

3838
## Contributing
3939

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ This command generates static content into the `build` directory and can be serv
3030

3131
## Deployment
3232

33-
Documentation is published on [DevHub](https://www.databricks.com/devhub/docs/appkit/v0/). GitHub Pages (`databricks.github.io/appkit/`) automatically redirects all existing URLs to DevHub via `.github/workflows/docs-deploy.yml`.
33+
Documentation is published on [developers.databricks.com](https://developers.databricks.com/docs/appkit/v0/). GitHub Pages (`databricks.github.io/appkit/`) automatically redirects all existing URLs to developers.databricks.com via `.github/workflows/docs-deploy.yml`.
3434

3535
The `pnpm build` command:
3636
1. Runs `docusaurus build` — generates HTML, `llms.txt`, and `.md` files
37-
2. Runs `apply-redirects` — replaces HTML pages with redirect pages pointing to DevHub
37+
2. Runs `apply-redirects` — replaces HTML pages with redirect pages pointing to developers.databricks.com
3838

3939
Static files remain served from GitHub Pages: JSON schemas (`/schemas/`), `llms.txt`, and `.md` files (used by `npx @databricks/appkit docs` for npm-bundled documentation).

docs/scripts/apply-redirects.ts

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Replaces all generated HTML pages with redirect pages pointing to DevHub.
2+
* Replaces all generated HTML pages with redirect pages pointing to developers.databricks.com.
33
* Run AFTER `docusaurus build` so that llms.txt and .md files are generated
44
* from the original HTML content first.
55
*
@@ -12,7 +12,7 @@ import { fileURLToPath } from "node:url";
1212

1313
const __dirname = dirname(fileURLToPath(import.meta.url));
1414
const BUILD_DIR = join(__dirname, "../build");
15-
const DEVHUB_BASE = "https://www.databricks.com/devhub/docs/appkit/v0";
15+
const DOCS_BASE = "https://developers.databricks.com/docs/appkit/v0";
1616

1717
function generateRedirectHtml(targetUrl: string): string {
1818
return `<!DOCTYPE html>
@@ -48,7 +48,7 @@ if (!existsSync(BUILD_DIR)) {
4848
process.exit(1);
4949
}
5050

51-
console.log("Applying DevHub redirects to HTML pages...");
51+
console.log("Applying developers.databricks.com redirects to HTML pages...");
5252

5353
const htmlFiles = findHtmlFiles(BUILD_DIR);
5454
let count = 0;
@@ -59,11 +59,12 @@ for (const htmlPath of htmlFiles) {
5959
.slice(BUILD_DIR.length)
6060
.replace(/\/index\.html$/, "");
6161

62-
// Map /docs/{path} → devhub /{path} (devhub flattens the /docs/ prefix)
62+
// Map /docs/{path} → /{path} (the target base already includes /docs/appkit/v0,
63+
// so strip the local docusaurus /docs/ route prefix before appending)
6364
const pathWithoutDocs = relativePath.replace(/^\/docs\/?/, "/");
64-
const devhubUrl = `${DEVHUB_BASE}${pathWithoutDocs || "/"}`;
65+
const targetUrl = `${DOCS_BASE}${pathWithoutDocs || "/"}`;
6566

66-
writeFileSync(htmlPath, generateRedirectHtml(devhubUrl));
67+
writeFileSync(htmlPath, generateRedirectHtml(targetUrl));
6768
count++;
6869
}
6970

@@ -77,13 +78,13 @@ const notFoundHtml = `<!DOCTYPE html>
7778
(function() {
7879
var path = window.location.pathname.replace(/^\\/appkit\\/?/, '/');
7980
path = path.replace(/^\\/docs\\/?/, '/');
80-
var target = "${DEVHUB_BASE}" + path + window.location.search + window.location.hash;
81+
var target = "${DOCS_BASE}" + path + window.location.search + window.location.hash;
8182
window.location.replace(target);
8283
})();
8384
</script>
8485
</head>
8586
<body>
86-
<p>Redirecting to <a href="${DEVHUB_BASE}/">AppKit Documentation</a>&hellip;</p>
87+
<p>Redirecting to <a href="${DOCS_BASE}/">AppKit Documentation</a>&hellip;</p>
8788
</body>
8889
</html>`;
8990
writeFileSync(join(BUILD_DIR, "404.html"), notFoundHtml);

packages/appkit/src/registry/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export * from "./types";
2929
* }
3030
* ```
3131
*
32-
* @see {@link https://www.databricks.com/devhub/docs/appkit/v0/ | AppKit Documentation}
32+
* @see {@link https://developers.databricks.com/docs/appkit/v0/ | AppKit Documentation}
3333
*/
3434
// TODO: We may want to open a PR to https://github.com/SchemaStore/schemastore
3535
// export const MANIFEST_SCHEMA_ID =

template/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# {{.projectName}}
22

3-
A Databricks App powered by [AppKit](https://www.databricks.com/devhub/docs/appkit/v0/), featuring React, TypeScript, and Tailwind CSS.
3+
A Databricks App powered by [AppKit](https://developers.databricks.com/docs/appkit/v0/), featuring React, TypeScript, and Tailwind CSS.
44

55
**Enabled plugins:**
66
{{- if .plugins.analytics}}
@@ -41,7 +41,7 @@ DATABRICKS_APP_PORT=8000
4141

4242
#### Lakebase Configuration
4343

44-
The Lakebase plugin requires additional environment variables for PostgreSQL connectivity. To learn how to configure the Lakebase plugin, see the [Lakebase plugin documentation](https://www.databricks.com/devhub/docs/appkit/v0/plugins/lakebase).
44+
The Lakebase plugin requires additional environment variables for PostgreSQL connectivity. To learn how to configure the Lakebase plugin, see the [Lakebase plugin documentation](https://developers.databricks.com/docs/appkit/v0/plugins/lakebase).
4545
{{- end}}
4646

4747
### CLI Authentication

template/client/src/App.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ function HomePage() {
211211
</li>
212212
<li>
213213
<a
214-
href="https://www.databricks.com/devhub/docs/appkit/v0/"
214+
href="https://developers.databricks.com/docs/appkit/v0/"
215215
target="_blank"
216216
rel="noopener noreferrer"
217217
className="text-primary underline underline-offset-4 hover:text-primary/80"

template/server/routes/lakebase/todo-routes.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{{if .plugins.lakebase -}}
22
// For per-user connections (OBO) with Row-Level Security, see:
3-
// https://www.databricks.com/devhub/docs/appkit/v0/plugins/lakebase#on-behalf-of-obo--per-user-connections
3+
// https://developers.databricks.com/docs/appkit/v0/plugins/lakebase#on-behalf-of-obo--per-user-connections
44

55
import { z } from 'zod';
66
import { Application } from 'express';
@@ -45,7 +45,7 @@ export async function setupSampleLakebaseRoutes(appkit: AppKitWithLakebase) {
4545
} catch (err) {
4646
console.warn('[lakebase] Database setup failed:', (err as Error).message);
4747
console.warn('[lakebase] Routes will be registered but may return errors');
48-
console.warn('[lakebase] See https://www.databricks.com/devhub/docs/appkit/v0/plugins/lakebase#database-permissions for troubleshooting');
48+
console.warn('[lakebase] See https://developers.databricks.com/docs/appkit/v0/plugins/lakebase#database-permissions for troubleshooting');
4949
}
5050

5151
appkit.server.extend((app) => {

0 commit comments

Comments
 (0)