From be5f2df14ed413aeb9fe54088f3111ec138e2bb8 Mon Sep 17 00:00:00 2001 From: Mark Burggraf Date: Tue, 8 Jun 2021 21:08:36 -0700 Subject: [PATCH] cleaned up document formats, removed unnecessary sections --- web/docs/guides/auth/auth-facebook.mdx | 19 +++---------------- web/docs/guides/auth/auth-github.mdx | 19 +++---------------- web/docs/guides/auth/auth-google.mdx | 19 +++---------------- web/docs/guides/database/arrays.mdx | 16 ++-------------- web/docs/guides/database/json.mdx | 16 ++-------------- web/docs/guides/database/password-reset.mdx | 15 +++++++++------ 6 files changed, 22 insertions(+), 82 deletions(-) diff --git a/web/docs/guides/auth/auth-facebook.mdx b/web/docs/guides/auth/auth-facebook.mdx index ee8327c5e84..0c5da06c9aa 100644 --- a/web/docs/guides/auth/auth-facebook.mdx +++ b/web/docs/guides/auth/auth-facebook.mdx @@ -7,11 +7,9 @@ description: Setting up Facebook Login import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -### Setting up Facebook Login - ## Description -Adding a Facebook Login button to your application is easy if you follow these steps. +How to set up Facebook Login The setup process consists of three parts: @@ -19,17 +17,6 @@ The setup process consists of three parts: * Add your Facebook keys to your [Supabase Project](https://supabase.io) * Add the login code to your [Supabase JS Client App](https://github.com/supabase/supabase-js) -## Environment - -* [Supabase JS Client](https://github.com/supabase/supabase-js) -* [Supabase Dashboard (UI)](https://supabase.io) -* [Facebook Developers Dashboard](https://developers.facebook.com/) - -## Requirements -* Supabase account (Free Tier OK) -* Any existing Supabase Project -* Javascript-based client application (Angular, React, Vue, etc.) - ## Steps ### Create a Facebook Developer Account @@ -54,8 +41,8 @@ From the "Add Products to your App" screen: - Skip the Quickstart screen, instead, in the left sidebar, click "Settings" under "Facebook Login" - Enter your callback URI under "Valid OAuth Redirect URIs" on the "Facebook Login Settings" page - Your OAuth Redirect URI looks like this: - - https://xxxxxxxxxxxxxxxx.supabase.co/auth/v1/callback - - where https://xxxxxxxxxxxxxxxx.supabase.co is your Supabase Project API URL + - `https://.supabase.co/auth/v1/callback` + - where `https://.supabase.co` is your Supabase Project API URL - Go to your [Supasebase Project Dashboard](https://supabase.io) - Click on the "Settings" icon at the bottom of the left sidebar - Click on "API" in the list diff --git a/web/docs/guides/auth/auth-github.mdx b/web/docs/guides/auth/auth-github.mdx index 359011643d5..74875794018 100644 --- a/web/docs/guides/auth/auth-github.mdx +++ b/web/docs/guides/auth/auth-github.mdx @@ -7,11 +7,9 @@ description: Setting up Github Login import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -### Setting up Github Login - ## Description -Adding a Github Login button to your application is easy if you follow these steps. +How to set up Github Login The setup process consists of three parts: @@ -19,17 +17,6 @@ The setup process consists of three parts: * Add your Github OAuth keys to your [Supabase Project](https://supabase.io) * Add the login code to your [Supabase JS Client App](https://github.com/supabase/supabase-js) -## Environment - -* [Supabase JS Client](https://github.com/supabase/supabase-js) -* [Supabase Dashboard (UI)](https://supabase.io) -* [Github Developer Settings](https://github.com/settings/developers) - -## Requirements -* Supabase account (Free Tier OK) -* Any existing Supabase Project -* Javascript-based client application (Angular, React, Vue, etc.) - ## Steps ### Log into your [Github](https://github.com) Account @@ -51,8 +38,8 @@ Register a new OAuth application - In "Homepage URL", type the full URL to your app's website. - In "Authorization callback URL", type the callback URL of your app. - Your OAuth Redirect URI looks like this: - - https://xxxxxxxxxxxxxxxx.supabase.co/auth/v1/callback - - where https://xxxxxxxxxxxxxxxx.supabase.co is your Supabase Project API URL + - `https://.supabase.co/auth/v1/callback` + - where `https://.supabase.co` is your Supabase Project API URL - Go to your [Supasebase Project Dashboard](https://supabase.io) - Click on the "Settings" icon at the bottom of the left sidebar - Click on "API" in the list diff --git a/web/docs/guides/auth/auth-google.mdx b/web/docs/guides/auth/auth-google.mdx index 255c4b42fbe..650e1b72526 100644 --- a/web/docs/guides/auth/auth-google.mdx +++ b/web/docs/guides/auth/auth-google.mdx @@ -7,11 +7,9 @@ description: Setting up Google Login import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -### Setting up Google Login - ## Description -Adding a Google Login button to your application is easy if you follow these steps. +How to set up Google Login The setup process consists of three parts: @@ -19,17 +17,6 @@ The setup process consists of three parts: * Add your Google OAuth keys to your [Supabase Project](https://supabase.io) * Add the login code to your [Supabase JS Client App](https://github.com/supabase/supabase-js) -## Environment - -* [Supabase JS Client](https://github.com/supabase/supabase-js) -* [Supabase Dashboard (UI)](https://supabase.io) -* [Google Cloud Platform Console](https://console.cloud.google.com/home/dashboard) - -## Requirements -* Supabase account (Free Tier OK) -* Any existing Supabase Project -* Javascript-based client application (Angular, React, Vue, etc.) - ## Steps ### Create a Google Cloud Platform Account @@ -70,8 +57,8 @@ Create your credentials - At the bottom, under "Authorised redirect URIs" click "Add URI" - Enter your callback URI under "Authorised redirect URIs" at the bottom - Your OAuth Redirect URI looks like this: - - https://xxxxxxxxxxxxxxxx.supabase.co/auth/v1/callback - - where https://xxxxxxxxxxxxxxxx.supabase.co is your Supabase Project API URL + - `https://.supabase.co/auth/v1/callback` + - where `https://.supabase.co` is your Supabase Project API URL - Go to your [Supasebase Project Dashboard](https://supabase.io) - Click on the "Settings" icon at the bottom of the left sidebar - Click on "API" in the list diff --git a/web/docs/guides/database/arrays.mdx b/web/docs/guides/database/arrays.mdx index f9168738b42..6b26968f24a 100644 --- a/web/docs/guides/database/arrays.mdx +++ b/web/docs/guides/database/arrays.mdx @@ -7,24 +7,12 @@ description: How to use arrays in PostgreSQL and the Supabase API. import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -### How to use arrays in PostgreSQL and the Supabase API. - ## Description +How to use arrays in PostgreSQL and the Supabase API + PostgreSQL supports flexible [array types](https://www.postgresql.org/docs/12/arrays.html). You can use arrays in your PostgreSQL tables in the Supabase dashboard and in the Javascript API. -## Environment - -* Supabase JS Client -* Supabase (or any PostgreSQL) backend -* Supabase Dashboard (UI) - - -## Requirements -* Supabase account or self-hosted Supabase instance -* Javascript-based client application (Angular, React, Vue, etc.) - - ## Steps ### Create a table with an array column diff --git a/web/docs/guides/database/json.mdx b/web/docs/guides/database/json.mdx index fab21f38202..d3a442f30d8 100644 --- a/web/docs/guides/database/json.mdx +++ b/web/docs/guides/database/json.mdx @@ -7,10 +7,10 @@ description: How to use JSON Data in PostgreSQL and the Supabase Javascript API. import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -### How to use JSON Data in PostgreSQL and the Supabase Javascript API. - ## Description +How to use JSON Data in PostgreSQL and the Supabase Javascript API + PostgreSQL supports [JSON functions and operators](https://www.postgresql.org/docs/12/functions-json.html) that can give you nearly unlimited flexiblity when storing data inside a database column. In this document you'll learn how to: * create database columns that store JSON data @@ -23,18 +23,6 @@ PostgreSQL supports two types of JSON columns: JSON and JSONB. The recommended From: [PostgreSQL JSON types](https://www.postgresql.org/docs/12/datatype-json.html) -## Environment - -* Supabase JS Client -* Supabase (or any PostgreSQL) backend -* Supabase Dashboard (UI) - - -## Requirements -* Supabase account or self-hosted Supabase instance -* Javascript-based client application (Angular, React, Vue, etc.) - - ## Steps ### Create a table with a JSON column. diff --git a/web/docs/guides/database/password-reset.mdx b/web/docs/guides/database/password-reset.mdx index 277fbf06df5..eede5c74f49 100644 --- a/web/docs/guides/database/password-reset.mdx +++ b/web/docs/guides/database/password-reset.mdx @@ -7,20 +7,23 @@ description: How to change your PostgreSQL database password. import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -### How to change your PostgreSQL database password. - ## Description +How to change your PostgreSQL database password + Your PostgreSQL database is the core of your Supabase project, so it's important to make sure it has a strong, secure password at all times. Changing the password is easy -- just make sure you choose a password that: -* is very secure +* **is very secure** * does not contain of the following symbols: **: / ? # ] [ @ ! $ & ' ( ) * + , ; =** These special symbols can conflict with connection string URLs or cause other problems, so it's best to avoid them. You can still make a secure password using a longer string or a randomized set of upper and lowercase letters and digits. -## Environment -* Any PostgreSQL database -* Any Supabase project +### How do I create a secure password? +- use a password manager to generate it, or +- make a long password (10 characters at least) +- don't use any common dictionary words +- use both upper and lower case characters, numbers, and any symbols not in the list above + ## Steps