From 42723d82321a8767c8cedbf304e6c97f7852bee2 Mon Sep 17 00:00:00 2001
From: Charis <26616127+charislam@users.noreply.github.com>
Date: Wed, 14 Feb 2024 12:39:05 -0500
Subject: [PATCH] refactor: move ai, realtime, functions, remaining auth docs
to content directory (#21259)
---
.github/workflows/prettier.yml | 3 +-
.../NavigationMenu.constants.ts | 10 +-
.../RealtimeLimitsEstimator.tsx} | 0
.../RealtimeLimitsEstimator/index.tsx | 11 ++
apps/docs/components/index.tsx | 4 +
apps/docs/{pages => content}/guides/ai.mdx | 62 +++---
.../guides/ai/choosing-compute-addon.mdx | 22 +--
.../{pages => content}/guides/ai/concepts.mdx | 18 +-
.../guides/ai/engineering-for-scale.mdx | 20 +-
.../ai/examples/building-chatgpt-plugins.mdx | 16 +-
.../ai/examples/headless-vector-search.mdx | 17 +-
.../examples/huggingface-image-captioning.mdx | 22 +--
.../ai/examples/image-search-openai-clip.mdx | 18 +-
.../ai/examples/nextjs-vector-search.mdx | 21 +--
.../guides/ai/examples/openai.mdx | 22 +--
.../guides/ai/going-to-prod.mdx | 20 +-
.../guides/ai/google-colab.mdx | 20 +-
.../guides/ai/hugging-face.mdx | 18 +-
.../guides/ai/integrations/llamaindex.mdx | 21 +--
.../guides/ai/integrations/roboflow.mdx | 19 +-
.../guides/ai/langchain.mdx | 21 +--
.../guides/ai/python-clients.mdx | 18 +-
.../guides/ai/quickstarts/face-similarity.mdx | 17 +-
.../quickstarts/generate-text-embeddings.mdx | 18 +-
.../guides/ai/quickstarts/hello-world.mdx | 19 +-
.../ai/quickstarts/text-deduplication.mdx | 20 +-
.../guides/ai/rag-with-permissions.mdx | 20 +-
.../guides/ai/structured-unstructured.mdx | 22 +--
.../guides/ai/vecs-python-client.mdx | 19 +-
.../guides/ai/vector-columns.mdx | 18 +-
.../guides/ai/vector-indexes.mdx | 18 +-
.../guides/ai/vector-indexes/hnsw-indexes.mdx | 18 +-
.../guides/ai/vector-indexes/ivf-indexes.mdx | 18 +-
.../auth-deep-dive/auth-deep-dive-jwts.mdx | 18 +-
.../auth-deep-dive/auth-google-oauth.mdx | 18 +-
.../auth}/auth-deep-dive/auth-gotrue.mdx | 16 +-
.../auth}/auth-deep-dive/auth-policies.mdx | 18 +-
.../auth-row-level-security.mdx | 18 +-
apps/docs/content/guides/functions.mdx | 170 +++++++++++++++++
.../guides/functions/auth.mdx | 18 +-
.../guides/functions/cicd-workflow.mdx | 20 +-
.../guides/functions/connect-to-postgres.mdx | 20 +-
.../guides/functions/cors.mdx | 16 +-
.../guides/functions/dart-edge.mdx | 16 +-
.../guides/functions/debugging.mdx | 18 +-
.../guides/functions/deploy.mdx | 20 +-
.../examples/cloudflare-turnstile.mdx | 18 +-
.../guides/functions/examples/discord-bot.mdx | 18 +-
.../functions/examples/github-actions.mdx | 18 +-
.../guides/functions/examples/og-image.mdx | 18 +-
.../functions/examples/push-notifications.mdx | 16 +-
.../functions/examples/rate-limiting.mdx | 14 +-
.../guides/functions/examples/screenshots.mdx | 14 +-
.../guides/functions/examples/send-emails.mdx | 16 +-
.../functions/examples/slack-bot-mention.mdx | 16 +-
.../functions/examples/stripe-webhooks.mdx | 14 +-
.../functions/examples/telegram-bot.mdx | 18 +-
.../functions/examples/upstash-redis.mdx | 14 +-
.../guides/functions/import-maps.mdx | 20 +-
.../guides/functions/kysely-postgres.mdx | 17 +-
.../guides/functions/local-development.mdx | 18 +-
.../guides/functions/quickstart.mdx | 20 +-
.../guides/functions/regional-invocation.mdx | 18 +-
.../guides/functions/routing.mdx | 18 +-
.../guides/functions/schedule-functions.mdx | 16 +-
.../guides/functions/secrets.mdx | 18 +-
.../guides/functions/storage-caching.mdx | 18 +-
.../guides/functions/unit-test.mdx | 18 +-
.../{pages => content}/guides/realtime.mdx | 48 ++---
.../guides/realtime/architecture.mdx | 18 +-
.../realtime/bring-your-own-database.mdx | 18 +-
.../guides/realtime/broadcast.mdx | 17 +-
.../guides/realtime/concepts.mdx | 20 +-
.../guides/client-side-throttling.mdx | 18 +-
.../guides/realtime/postgres-changes.mdx | 21 +--
.../guides/realtime/presence.mdx | 18 +-
.../guides/realtime/protocol.mdx | 15 +-
.../guides/realtime/quotas.mdx | 18 +-
.../guides/realtime/realtime-with-nextjs.mdx | 18 +-
.../subscribing-to-database-changes.mdx | 18 +-
apps/docs/pages/guides/ai/[[...slug]].tsx | 28 +++
apps/docs/pages/guides/functions.mdx | 178 ------------------
.../pages/guides/functions/[[...slug]].tsx | 28 +++
.../pages/guides/realtime/[[...slug]].tsx | 28 +++
apps/docs/scripts/codemod/mdx-meta.mjs | 2 +-
apps/www/lib/redirects.js | 37 +++-
86 files changed, 780 insertions(+), 1139 deletions(-)
rename apps/docs/components/{RealtimeLimitsEstimater.tsx => RealtimeLimitsEstimator/RealtimeLimitsEstimator.tsx} (100%)
create mode 100644 apps/docs/components/RealtimeLimitsEstimator/index.tsx
rename apps/docs/{pages => content}/guides/ai.mdx (73%)
rename apps/docs/{pages => content}/guides/ai/choosing-compute-addon.mdx (97%)
rename apps/docs/{pages => content}/guides/ai/concepts.mdx (91%)
rename apps/docs/{pages => content}/guides/ai/engineering-for-scale.mdx (91%)
rename apps/docs/{pages => content}/guides/ai/examples/building-chatgpt-plugins.mdx (95%)
rename apps/docs/{pages => content}/guides/ai/examples/headless-vector-search.mdx (91%)
rename apps/docs/{pages => content}/guides/ai/examples/huggingface-image-captioning.mdx (86%)
rename apps/docs/{pages => content}/guides/ai/examples/image-search-openai-clip.mdx (93%)
rename apps/docs/{pages => content}/guides/ai/examples/nextjs-vector-search.mdx (97%)
rename apps/docs/{pages => content}/guides/ai/examples/openai.mdx (86%)
rename apps/docs/{pages => content}/guides/ai/going-to-prod.mdx (95%)
rename apps/docs/{pages => content}/guides/ai/google-colab.mdx (90%)
rename apps/docs/{pages => content}/guides/ai/hugging-face.mdx (95%)
rename apps/docs/{pages => content}/guides/ai/integrations/llamaindex.mdx (83%)
rename apps/docs/{pages => content}/guides/ai/integrations/roboflow.mdx (95%)
rename apps/docs/{pages => content}/guides/ai/langchain.mdx (94%)
rename apps/docs/{pages => content}/guides/ai/python-clients.mdx (77%)
rename apps/docs/{pages => content}/guides/ai/quickstarts/face-similarity.mdx (87%)
rename apps/docs/{pages => content}/guides/ai/quickstarts/generate-text-embeddings.mdx (95%)
rename apps/docs/{pages => content}/guides/ai/quickstarts/hello-world.mdx (87%)
rename apps/docs/{pages => content}/guides/ai/quickstarts/text-deduplication.mdx (85%)
rename apps/docs/{pages => content}/guides/ai/rag-with-permissions.mdx (96%)
rename apps/docs/{pages => content}/guides/ai/structured-unstructured.mdx (86%)
rename apps/docs/{pages => content}/guides/ai/vecs-python-client.mdx (84%)
rename apps/docs/{pages => content}/guides/ai/vector-columns.mdx (95%)
rename apps/docs/{pages => content}/guides/ai/vector-indexes.mdx (84%)
rename apps/docs/{pages => content}/guides/ai/vector-indexes/hnsw-indexes.mdx (94%)
rename apps/docs/{pages => content}/guides/ai/vector-indexes/ivf-indexes.mdx (92%)
rename apps/docs/{pages/learn => content/guides/auth}/auth-deep-dive/auth-deep-dive-jwts.mdx (96%)
rename apps/docs/{pages/learn => content/guides/auth}/auth-deep-dive/auth-google-oauth.mdx (93%)
rename apps/docs/{pages/learn => content/guides/auth}/auth-deep-dive/auth-gotrue.mdx (92%)
rename apps/docs/{pages/learn => content/guides/auth}/auth-deep-dive/auth-policies.mdx (95%)
rename apps/docs/{pages/learn => content/guides/auth}/auth-deep-dive/auth-row-level-security.mdx (93%)
create mode 100644 apps/docs/content/guides/functions.mdx
rename apps/docs/{pages => content}/guides/functions/auth.mdx (88%)
rename apps/docs/{pages => content}/guides/functions/cicd-workflow.mdx (84%)
rename apps/docs/{pages => content}/guides/functions/connect-to-postgres.mdx (89%)
rename apps/docs/{pages => content}/guides/functions/cors.mdx (80%)
rename apps/docs/{pages => content}/guides/functions/dart-edge.mdx (94%)
rename apps/docs/{pages => content}/guides/functions/debugging.mdx (96%)
rename apps/docs/{pages => content}/guides/functions/deploy.mdx (86%)
rename apps/docs/{pages => content}/guides/functions/examples/cloudflare-turnstile.mdx (86%)
rename apps/docs/{pages => content}/guides/functions/examples/discord-bot.mdx (94%)
rename apps/docs/{pages => content}/guides/functions/examples/github-actions.mdx (79%)
rename apps/docs/{pages => content}/guides/functions/examples/og-image.mdx (77%)
rename apps/docs/{pages => content}/guides/functions/examples/push-notifications.mdx (97%)
rename apps/docs/{pages => content}/guides/functions/examples/rate-limiting.mdx (76%)
rename apps/docs/{pages => content}/guides/functions/examples/screenshots.mdx (69%)
rename apps/docs/{pages => content}/guides/functions/examples/send-emails.mdx (85%)
rename apps/docs/{pages => content}/guides/functions/examples/slack-bot-mention.mdx (86%)
rename apps/docs/{pages => content}/guides/functions/examples/stripe-webhooks.mdx (61%)
rename apps/docs/{pages => content}/guides/functions/examples/telegram-bot.mdx (61%)
rename apps/docs/{pages => content}/guides/functions/examples/upstash-redis.mdx (91%)
rename apps/docs/{pages => content}/guides/functions/import-maps.mdx (89%)
rename apps/docs/{pages => content}/guides/functions/kysely-postgres.mdx (95%)
rename apps/docs/{pages => content}/guides/functions/local-development.mdx (87%)
rename apps/docs/{pages => content}/guides/functions/quickstart.mdx (94%)
rename apps/docs/{pages => content}/guides/functions/regional-invocation.mdx (85%)
rename apps/docs/{pages => content}/guides/functions/routing.mdx (91%)
rename apps/docs/{pages => content}/guides/functions/schedule-functions.mdx (81%)
rename apps/docs/{pages => content}/guides/functions/secrets.mdx (88%)
rename apps/docs/{pages => content}/guides/functions/storage-caching.mdx (54%)
rename apps/docs/{pages => content}/guides/functions/unit-test.mdx (94%)
rename apps/docs/{pages => content}/guides/realtime.mdx (83%)
rename apps/docs/{pages => content}/guides/realtime/architecture.mdx (91%)
rename apps/docs/{pages => content}/guides/realtime/bring-your-own-database.mdx (90%)
rename apps/docs/{pages => content}/guides/realtime/broadcast.mdx (96%)
rename apps/docs/{pages => content}/guides/realtime/concepts.mdx (91%)
rename apps/docs/{pages => content}/guides/realtime/guides/client-side-throttling.mdx (83%)
rename apps/docs/{pages => content}/guides/realtime/postgres-changes.mdx (98%)
rename apps/docs/{pages => content}/guides/realtime/presence.mdx (93%)
rename apps/docs/{pages => content}/guides/realtime/protocol.mdx (94%)
rename apps/docs/{pages => content}/guides/realtime/quotas.mdx (92%)
rename apps/docs/{pages => content}/guides/realtime/realtime-with-nextjs.mdx (56%)
rename apps/docs/{pages => content}/guides/realtime/subscribing-to-database-changes.mdx (85%)
create mode 100644 apps/docs/pages/guides/ai/[[...slug]].tsx
delete mode 100644 apps/docs/pages/guides/functions.mdx
create mode 100644 apps/docs/pages/guides/functions/[[...slug]].tsx
create mode 100644 apps/docs/pages/guides/realtime/[[...slug]].tsx
diff --git a/.github/workflows/prettier.yml b/.github/workflows/prettier.yml
index cc2d29c565..886a2d41b4 100644
--- a/.github/workflows/prettier.yml
+++ b/.github/workflows/prettier.yml
@@ -63,6 +63,7 @@ jobs:
with:
sparse-checkout: |
apps/docs/pages
+ apps/docs/content
# Installing all dependencies takes up to three minutes, hacking around to only installing prettier+deps
- name: Download dependencies
run: |
@@ -72,4 +73,4 @@ jobs:
- name: Run prettier
run: |-
# Check mdx files which contain sql code blocks
- grep -lr '```sql' apps/docs/pages/**/*.mdx | xargs npx prettier -c
+ grep -lr '```sql' apps/docs/{pages,content}/**/*.mdx | xargs npx prettier -c
diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts
index 0032272473..7ca574c6ea 100644
--- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts
+++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts
@@ -657,20 +657,20 @@ export const auth = {
items: [
{
name: 'Part One: JWTs',
- url: '/learn/auth-deep-dive/auth-deep-dive-jwts',
+ url: '/guides/auth/auth-deep-dive/auth-deep-dive-jwts',
},
{
name: 'Part Two: Row Level Security',
- url: '/learn/auth-deep-dive/auth-row-level-security',
+ url: '/guides/auth/auth-deep-dive/auth-row-level-security',
},
{
name: 'Part Three: Policies',
- url: '/learn/auth-deep-dive/auth-policies',
+ url: '/guides/auth/auth-deep-dive/auth-policies',
},
- { name: 'Part Four: GoTrue', url: '/learn/auth-deep-dive/auth-gotrue' },
+ { name: 'Part Four: GoTrue', url: '/guides/auth/auth-deep-dive/auth-gotrue' },
{
name: 'Part Five: Google OAuth',
- url: '/learn/auth-deep-dive/auth-google-oauth',
+ url: '/guides/auth/auth-deep-dive/auth-google-oauth',
},
],
},
diff --git a/apps/docs/components/RealtimeLimitsEstimater.tsx b/apps/docs/components/RealtimeLimitsEstimator/RealtimeLimitsEstimator.tsx
similarity index 100%
rename from apps/docs/components/RealtimeLimitsEstimater.tsx
rename to apps/docs/components/RealtimeLimitsEstimator/RealtimeLimitsEstimator.tsx
diff --git a/apps/docs/components/RealtimeLimitsEstimator/index.tsx b/apps/docs/components/RealtimeLimitsEstimator/index.tsx
new file mode 100644
index 0000000000..34fe3d20a4
--- /dev/null
+++ b/apps/docs/components/RealtimeLimitsEstimator/index.tsx
@@ -0,0 +1,11 @@
+import { lazy, Suspense } from 'react'
+
+const Estimator = lazy(() => import('./RealtimeLimitsEstimator'))
+
+export function RealtimeLimitsEstimator() {
+ return (
+