From 18e026abd782c214482e004aea45ee87409fde00 Mon Sep 17 00:00:00 2001 From: awalias Date: Mon, 27 Jan 2020 11:43:02 +0800 Subject: [PATCH] adding decriptions to docs to mitigate og:description issue #10 --- package-lock.json | 3 +++ web/docs/about.md | 1 + web/docs/faq.md | 1 + web/docs/guides/examples.mdx | 1 + web/docs/handbook/introduction.mdx | 1 + web/docs/hosting/realtime.mdx | 3 ++- web/docs/library/authentication.mdx | 1 + web/docs/library/delete.mdx | 1 + web/docs/library/get.mdx | 1 + web/docs/library/getting-started.mdx | 1 + web/docs/library/patch.mdx | 1 + web/docs/library/post.mdx | 1 + web/docs/library/stored-procedures.mdx | 1 + web/docs/library/subscribe.mdx | 1 + 14 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 package-lock.json diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 00000000000..48e341a0954 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,3 @@ +{ + "lockfileVersion": 1 +} diff --git a/web/docs/about.md b/web/docs/about.md index c0e5f46285e..8cae1a9c807 100755 --- a/web/docs/about.md +++ b/web/docs/about.md @@ -1,6 +1,7 @@ --- id: about title: About +description: 'What is Supabase?' --- ## What it is diff --git a/web/docs/faq.md b/web/docs/faq.md index a066c536e95..687e807575c 100755 --- a/web/docs/faq.md +++ b/web/docs/faq.md @@ -1,6 +1,7 @@ --- id: faq title: FAQs +description: 'Most frequently asked questions regarding Supabase' --- ## Do you support (some other database)? diff --git a/web/docs/guides/examples.mdx b/web/docs/guides/examples.mdx index ceba2b57d14..632c88c490e 100644 --- a/web/docs/guides/examples.mdx +++ b/web/docs/guides/examples.mdx @@ -1,6 +1,7 @@ --- id: examples title: Examples +description: 'Examples you can use to get started with supabase' --- Supabase is still in Alpha. We will release some examples once we are in Beta and our APIs have stabalized. \ No newline at end of file diff --git a/web/docs/handbook/introduction.mdx b/web/docs/handbook/introduction.mdx index 4e09ca309f7..69d9bb2bcae 100644 --- a/web/docs/handbook/introduction.mdx +++ b/web/docs/handbook/introduction.mdx @@ -1,6 +1,7 @@ --- id: introduction title: Supabase Handbook +description: 'The Supabase public handbook and manifesto' --- Supabase is thinking in public. Everything is online, no matter how raw the current state of things. diff --git a/web/docs/hosting/realtime.mdx b/web/docs/hosting/realtime.mdx index 2a2d72122d6..b40144eb5dc 100644 --- a/web/docs/hosting/realtime.mdx +++ b/web/docs/hosting/realtime.mdx @@ -1,6 +1,7 @@ --- id: hosting-realtime title: On-premise Realtime +description: 'Setting up a Supabase instance' --- > Status: DRAFT @@ -30,7 +31,7 @@ CREATE PUBLICATION supabase_realtime FOR ALL TABLES; -- Set up the publication f ### Optional -If you want to recieve the old record (previous values) on `UDPATE` and `DELETE`, you can set the `REPLICA IDENTITY` to `FULL` like this: +If you want to recieve the old record (previous values) on `UPDATE` and `DELETE`, you can set the `REPLICA IDENTITY` to `FULL` like this: ```sql ALTER TABLE your_table SET REPLICA IDENTITY = FULL; diff --git a/web/docs/library/authentication.mdx b/web/docs/library/authentication.mdx index 028072eaf34..aa0fe138090 100755 --- a/web/docs/library/authentication.mdx +++ b/web/docs/library/authentication.mdx @@ -1,6 +1,7 @@ --- id: authentication title: Authentication +description: 'How to do Authentication with Supabase' --- @todo \ No newline at end of file diff --git a/web/docs/library/delete.mdx b/web/docs/library/delete.mdx index 5897e02d6d8..0ab4aa5ed8d 100644 --- a/web/docs/library/delete.mdx +++ b/web/docs/library/delete.mdx @@ -1,6 +1,7 @@ --- id: delete title: 'Deleting' +description: 'How to delete records from your database with Supabase' --- import DummyData from '../common/DummyData.mdx' diff --git a/web/docs/library/get.mdx b/web/docs/library/get.mdx index 5ce6c3aad6a..a962752497c 100644 --- a/web/docs/library/get.mdx +++ b/web/docs/library/get.mdx @@ -1,6 +1,7 @@ --- id: get title: 'Reading' +description: 'How to fetch records from your database with Supabase' --- import Tabs from '@theme/Tabs' diff --git a/web/docs/library/getting-started.mdx b/web/docs/library/getting-started.mdx index b9f40833d6a..37f935e18c4 100755 --- a/web/docs/library/getting-started.mdx +++ b/web/docs/library/getting-started.mdx @@ -1,6 +1,7 @@ --- id: getting-started title: Getting Started +description: 'How to install Supabase and start interacting with your database' --- diff --git a/web/docs/library/patch.mdx b/web/docs/library/patch.mdx index 0ddcf53f646..991cbd954fa 100644 --- a/web/docs/library/patch.mdx +++ b/web/docs/library/patch.mdx @@ -1,6 +1,7 @@ --- id: patch title: 'Updating' +description: 'How to update records in your database with Supabase' --- diff --git a/web/docs/library/post.mdx b/web/docs/library/post.mdx index 70c2d968313..cbaa52d9446 100644 --- a/web/docs/library/post.mdx +++ b/web/docs/library/post.mdx @@ -1,6 +1,7 @@ --- id: post title: 'Creating' +description: 'Add new records to your database with Supabase' --- diff --git a/web/docs/library/stored-procedures.mdx b/web/docs/library/stored-procedures.mdx index 49c120f51ec..4a8d9a10290 100644 --- a/web/docs/library/stored-procedures.mdx +++ b/web/docs/library/stored-procedures.mdx @@ -1,6 +1,7 @@ --- id: stored-procedures title: 'Stored Procedures' +description: 'How to use stored procedures (rpc) with Supabase' --- import Collapsable from '../../src/components/Collapsable' diff --git a/web/docs/library/subscribe.mdx b/web/docs/library/subscribe.mdx index 62827ecf8dd..f97628c0b63 100644 --- a/web/docs/library/subscribe.mdx +++ b/web/docs/library/subscribe.mdx @@ -1,6 +1,7 @@ --- id: subscribe title: 'Subscribing' +description: 'Subscribe to realtime changes in your database with Supabase' --- import DummyData from '../common/DummyData.mdx'