From d3bbc4eda5f08f9aaf2406f3f460aef9b4fd7fc0 Mon Sep 17 00:00:00 2001 From: Paul Copplestone Date: Mon, 28 Oct 2019 11:06:27 +0000 Subject: [PATCH] Removing all the foobars from the docs. They ain't helping nobody --- packages/web/components/NavbarDocs.js | 2 +- packages/web/content/docs/-/about.mdx | 13 +++++++++---- packages/web/content/docs/-/contributing.mdx | 16 ++++++++++++++++ .../content/docs/admin-api/getting-started.mdx | 8 ++++++-- .../content/docs/baseless/getting-started.mdx | 7 +++++-- .../web/content/docs/graphql/getting-started.mdx | 6 ++---- .../content/docs/packaged/getting-started.mdx | 4 ++++ .../web/content/docs/restful/getting-started.mdx | 6 ++---- packages/web/pages/docs/[category]/[slug].js | 2 +- 9 files changed, 46 insertions(+), 18 deletions(-) create mode 100644 packages/web/content/docs/-/contributing.mdx diff --git a/packages/web/components/NavbarDocs.js b/packages/web/components/NavbarDocs.js index f4e6d9aa8c4..bb588bacafd 100644 --- a/packages/web/components/NavbarDocs.js +++ b/packages/web/components/NavbarDocs.js @@ -17,7 +17,7 @@ export default function Navbar({}) {
  • - Home + Supabase
  • diff --git a/packages/web/content/docs/-/about.mdx b/packages/web/content/docs/-/about.mdx index 70ec036009c..b6069607148 100644 --- a/packages/web/content/docs/-/about.mdx +++ b/packages/web/content/docs/-/about.mdx @@ -1,16 +1,21 @@ +import Link from 'next/link' export const metadata = { title: 'Supabase', - description: 'Supabase Docs', + description: 'Supercharge PostgreSQL.', sidebarLabel: 'About' } +## Single source of truth +This is the single source of truth for Supabase documentation and information. -## Docs +We are a lean, open source company. To make things easier you you (and us) all documentation will point here. -- Key concepts -- FAQs +## Contributions +Did you see above that we're an open source company? If you like what we're doing and you want to help, we will go out of our way to help you help us. Whether you're a first time open source contributor or a veteran, we'd love your help. + +To learn more go to [Contributing](/docs/-/contributing). ## In Production diff --git a/packages/web/content/docs/-/contributing.mdx b/packages/web/content/docs/-/contributing.mdx new file mode 100644 index 00000000000..04983999064 --- /dev/null +++ b/packages/web/content/docs/-/contributing.mdx @@ -0,0 +1,16 @@ +export const metadata = { + title: 'Contributing', + description: 'Supabase Contribution Guidelines.' +} + +## Want to contribute? + +So ... we're even looking for contributions on our contributions guidelines. + +Supabase is thinking in public. Everything is online, no matter how raw the current state of things. + +We'll make this awesome we promise, but if you can't wait then why not jump into our github and: + +- submit an issue +- create a pull request +- try one of our products and give feedback \ No newline at end of file diff --git a/packages/web/content/docs/admin-api/getting-started.mdx b/packages/web/content/docs/admin-api/getting-started.mdx index 04321ad6df2..37ade8eae9e 100644 --- a/packages/web/content/docs/admin-api/getting-started.mdx +++ b/packages/web/content/docs/admin-api/getting-started.mdx @@ -5,7 +5,11 @@ export const metadata = { } +## Motivation -## Why? +SQL is a bit foreign for a lot of developers. We are hoping to bridge the gap. -SQL is a bit foreign for a lot of developers. We are hoping to bridge the gap. \ No newline at end of file + +## Coming soon + +We're busy making Realtime awesome right now, and we'll get around to this as soon as we can. \ No newline at end of file diff --git a/packages/web/content/docs/baseless/getting-started.mdx b/packages/web/content/docs/baseless/getting-started.mdx index 3ba869e2326..4b5110a6f69 100644 --- a/packages/web/content/docs/baseless/getting-started.mdx +++ b/packages/web/content/docs/baseless/getting-started.mdx @@ -3,9 +3,12 @@ export const metadata = { description: 'We\'re building a serverless PostgreSQL so you can get started in seconds. Export your database to a fully native PostgreSQL instance at any time.' } - ## Motivation Relational databases are great but the set up can be cumbersome for quick prototyping and small products. Additionally, even a small Postgres database can cost you $5/month. -We want to provide developers with the fastest and cheapest route to market using PostgreSQL. \ No newline at end of file +We want to provide developers with the fastest and cheapest route to market using PostgreSQL. + +## Coming soon + +We're busy making Realtime awesome right now, and we'll get around to this as soon as we can. \ No newline at end of file diff --git a/packages/web/content/docs/graphql/getting-started.mdx b/packages/web/content/docs/graphql/getting-started.mdx index 5b26fa787d3..1546e7ab605 100644 --- a/packages/web/content/docs/graphql/getting-started.mdx +++ b/packages/web/content/docs/graphql/getting-started.mdx @@ -3,8 +3,6 @@ export const metadata = { description: 'Extend your database with a fully functional GraphQL API, without a line of code.' } +## Coming soon -# Hello world - - -FOo bAr \ No newline at end of file +We're busy making Realtime awesome right now, and we'll get around to this as soon as we can. \ No newline at end of file diff --git a/packages/web/content/docs/packaged/getting-started.mdx b/packages/web/content/docs/packaged/getting-started.mdx index 5710a101f9f..6dd2f927826 100644 --- a/packages/web/content/docs/packaged/getting-started.mdx +++ b/packages/web/content/docs/packaged/getting-started.mdx @@ -3,3 +3,7 @@ export const metadata = { description: 'PostgreSQL is easy, we\'re just making it slightly easier.', sidebarLabel: 'Getting Started' } + +## Coming soon + +We're busy making Realtime awesome right now, and we'll get around to this as soon as we can. \ No newline at end of file diff --git a/packages/web/content/docs/restful/getting-started.mdx b/packages/web/content/docs/restful/getting-started.mdx index 5cc9d7dd5e5..7ef28d04551 100644 --- a/packages/web/content/docs/restful/getting-started.mdx +++ b/packages/web/content/docs/restful/getting-started.mdx @@ -4,8 +4,6 @@ export const metadata = { sidebarLabel: 'Getting Started' } +## Coming soon -# Hello world - - -FOo bAr \ No newline at end of file +We're busy making Realtime awesome right now, and we'll get around to this as soon as we can. \ No newline at end of file diff --git a/packages/web/pages/docs/[category]/[slug].js b/packages/web/pages/docs/[category]/[slug].js index 4d77669b9ba..81932a6bb6c 100644 --- a/packages/web/pages/docs/[category]/[slug].js +++ b/packages/web/pages/docs/[category]/[slug].js @@ -25,7 +25,7 @@ Docs['baseless'] = importReducer(require.context('../../../content/docs/baseless // Set up all sidebars var Sidebars = [] Sidebars['-'] = { - introduction: ['about'], + introduction: ['about', 'contributing'], } Sidebars['packaged'] = { introduction: ['getting-started'],