From 2e000ff608a50331129d419fafdc9f66d8d037b4 Mon Sep 17 00:00:00 2001 From: Terry Sutton Date: Fri, 17 Feb 2023 11:31:10 -0330 Subject: [PATCH] Add a note on env vars --- apps/docs/.env.example | 3 +++ apps/docs/DEVELOPERS.md | 7 ++++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/apps/docs/.env.example b/apps/docs/.env.example index bbf747a73ef..24f1544c0e9 100644 --- a/apps/docs/.env.example +++ b/apps/docs/.env.example @@ -5,3 +5,6 @@ NEXT_PUBLIC_SUPABASE_ANON_KEY= # PRIVATE OPENAI_KEY= SUPABASE_SERVICE_ROLE_KEY= + +# Set IS_PLATFORM to true if you have the api keys and urls +NEXT_PUBLIC_IS_PLATFORM=false diff --git a/apps/docs/DEVELOPERS.md b/apps/docs/DEVELOPERS.md index 50ea5d9deec..3935d5e0ce0 100644 --- a/apps/docs/DEVELOPERS.md +++ b/apps/docs/DEVELOPERS.md @@ -14,9 +14,10 @@ For a complete run-down on how all of our tools work together, see the main DEVE [supabase.com/docs](https://supabase.com/docs) is a Next.JS site. You can get setup by following the same steps for all of our other Next.JS projects: 1. Follow the steps outlined in the Local Development section of the main [DEVELOPERS.md](https://github.com/supabase/supabase/blob/master/DEVELOPERS.md) -2. Start the local docs site by navigating to `/apps/docs` and running `npm run dev` -3. Visit http://localhost:3001/docs in your browser - don't forget to append the `/docs` to the end -4. Your local site should look exactly like [https://supabase.com/docs](https://supabase.com/docs) +2. If you work at Supabase, run `dev:secrets:pull` to pull down the internal environment variables. If you're a community member, create a `.env` file and add this line to it: `NEXT_PUBLIC_IS_PLATFORM=false` +3. Start the local docs site by navigating to `/apps/docs` and running `npm run dev` +4. Visit http://localhost:3001/docs in your browser - don't forget to append the `/docs` to the end +5. Your local site should look exactly like [https://supabase.com/docs](https://supabase.com/docs) ## Types of documentation