Merge pull request #9085 from supabase/chore/update-docs-sidebar

Update docs sidebar
This commit is contained in:
dng authored and GitHub committed 2022-09-23 07:32:54 -07:00
commit 4e070baedd
4 files changed
+90 -90

No files matched your search

-11
View File
@@ -47,17 +47,6 @@ After developing your project and deciding it's time to Go Live With Real Users,
- Nightly backups for Pro tier projects are available on the Supabase dashboard for up to 7 days.
- Upgrading to the Supabase Pro Tier will give you access to email support on support@supabase.io
## Platform status
If Supabase experiences outages, we keep you as informed as possible, as early as possible. We provide the following feedback channels:
- Status page: [status.supabase.com](https://status.supabase.com/)
- RSS Feed: [status.supabase.com/history.rss](https://status.supabase.com/history.rss)
- Atom Feed: [status.supabase.com/history.atom](https://status.supabase.com/history.atom)
- Slack Alerts: You can receive updates via the RSS feed, using Slack's [built-in RSS functionality](https://slack.com/help/articles/218688467-Add-RSS-feeds-to-Slack) <br />`/feed subscribe https://status.supabase.com/history.atom`
Make sure to review our [SLA](/docs/company/sla) for details on our commitment to Platform Stability.
## Next steps
This checklist is always growing so be sure to check back frequently, and also feel free to suggest additions and amendments by making a PR on [GitHub](https://github.com/supabase/supabase).
+52 -38
View File
@@ -2,6 +2,7 @@
id: platform
title: Supabase Platform
description: Getting started with the Supabase Platform.
sidebar_label: Overview
---
Supabase is a hosted platform which makes it very simple to get started without needing to manage any infrastructure.
@@ -10,12 +11,14 @@ Visit [app.supabase.com](https://app.supabase.com) and sign in to start creating
## Projects
Each project on Supabase comes with these features:
Each project on Supabase comes with:
- A dedicated Postgres database. [Learn more](/docs/guides/database)
- Auto-generated APIs. [Learn more](/docs/guides/api)
- Auth and User management. [Learn more](/docs/guides/auth)
- Storage. [Learn more](/docs/guides/storage)
- A dedicated [Postgres database](/docs/guides/database)
- [Auto-generated APIs](/docs/guides/api)
- [Auth and user management](/docs/guides/auth)
- [Edge Functions](/docs/guides/functions)
- [Realtime API](/docs/guides/realtime)
- [Storage](/docs/guides/storage)
## Organizations
@@ -31,36 +34,47 @@ You can invite your team members into your organizations to collaborate on proje
You can also assign roles to your team members with different access levels. The table below shows the corresponding permissions for each available role in the Dashboard.
| Permissions | Owner | Administrator | Developer |
| ---------------------------- | ----- | ------------- | --------- |
| **Organization** |
| Can change organization name | ✅ | | |
| Can delete organization | ✅ | | |
| **Members** |
| Can add an Owner | ✅ | | |
| Can remove an Owner | ✅ | | |
| Can add an Adminstrator | ✅ | ✅ | |
| Can remove an Administrator | ✅ | ✅ | |
| Can add a Developer | ✅ | ✅ | |
| Can remove a Developer | ✅ | ✅ | |
| Can revoke an invite | ✅ | ✅ | |
| Can resend an invite | ✅ | ✅ | |
| **Billing** |
| Can read invoices | ✅ | ✅ | ✅ |
| Can read billing email | ✅ | ✅ | ✅ |
| Can change billing email | ✅ | | |
| Can view subscription | ✅ | ✅ | ✅ |
| Can update subscription | ✅ | ✅ | |
| Can read billing address | ✅ | ✅ | ✅ |
| Can update billing address | ✅ | ✅ | |
| Can read tax codes | ✅ | ✅ | ✅ |
| Can update tax codes | ✅ | ✅ | |
| Can read payment methods | ✅ | ✅ | ✅ |
| Can update payment methods | ✅ | ✅ | |
| **Projects** |
| Can create a project | ✅ | ✅ | |
| Can delete a project | ✅ | ✅ | |
| Can update a project | ✅ | ✅ | |
| Can pause a project | ✅ | ✅ | |
| Can resume a project | ✅ | ✅ | |
| Can restart a project | ✅ | ✅ | ✅ |
| Permissions | Owner | Administrator | Developer |
| ------------------------ | ----- | ------------- | --------- |
| **Organization** |
| Change organization name | ✅ | | |
| Delete organization | ✅ | | |
| **Members** |
| Add an Owner | ✅ | | |
| Remove an Owner | ✅ | | |
| Add an Adminstrator | ✅ | ✅ | |
| Remove an Administrator | ✅ | ✅ | |
| Add a Developer | ✅ | ✅ | |
| Remove a Developer | ✅ | ✅ | |
| Revoke an invite | ✅ | ✅ | |
| Resend an invite | ✅ | ✅ | |
| **Billing** |
| Read invoices | ✅ | ✅ | ✅ |
| Read billing email | ✅ | ✅ | ✅ |
| Change billing email | ✅ | | |
| View subscription | ✅ | ✅ | ✅ |
| Update subscription | ✅ | ✅ | |
| Read billing address | ✅ | ✅ | ✅ |
| Update billing address | ✅ | ✅ | |
| Read tax codes | ✅ | ✅ | ✅ |
| Update tax codes | ✅ | ✅ | |
| Read payment methods | ✅ | ✅ | ✅ |
| Update payment methods | ✅ | ✅ | |
| **Projects** |
| Create a project | ✅ | ✅ | |
| Delete a project | ✅ | ✅ | |
| Update a project | ✅ | ✅ | |
| Pause a project | ✅ | ✅ | |
| Resume a project | ✅ | ✅ | |
| Restart a project | ✅ | ✅ | ✅ |
## Platform status
If Supabase experiences outages, we keep you as informed as possible, as early as possible. We provide the following feedback channels:
- Status page: [status.supabase.com](https://status.supabase.com/)
- RSS Feed: [status.supabase.com/history.rss](https://status.supabase.com/history.rss)
- Atom Feed: [status.supabase.com/history.atom](https://status.supabase.com/history.atom)
- Slack Alerts: You can receive updates via the RSS feed, using Slack's [built-in RSS functionality](https://slack.com/help/articles/218688467-Add-RSS-feeds-to-Slack) <br />`/feed subscribe https://status.supabase.com/history.atom`
Make sure to review our [SLA](/docs/company/sla) for details on our commitment to Platform Stability.
+24 -9
View File
@@ -190,6 +190,22 @@ const config = {
label: 'Open source',
to: '/oss',
},
{
label: 'Terms of Service',
to: '/docs/company/terms',
},
{
label: 'Privacy Policy',
to: '/docs/company/privacy',
},
{
label: 'Acceptable Use Policy',
to: '/docs/company/aup',
},
{
label: 'Service Level Agreement',
to: '/docs/company/sla',
},
{
label: 'Humans.txt',
to: 'https://supabase.com/humans.txt',
@@ -228,6 +244,14 @@ const config = {
{
title: 'Community',
items: [
{
label: 'SupaSquad',
href: 'https://supabase.com/docs/handbook/supasquad',
},
{
label: 'Contributing',
href: 'https://supabase.com/docs/handbook/contributing',
},
{
label: 'GitHub',
href: 'https://github.com/supabase/supabase',
@@ -250,15 +274,6 @@ const config = {
},
],
},
{
title: 'Beta',
items: [
{
label: 'Join our beta',
href: 'https://app.supabase.com',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Supabase.`,
},
+14 -32
View File
@@ -4,12 +4,7 @@ const sidebars = {
type: 'category',
label: 'Overview',
collapsed: true,
items: [
'about',
'architecture',
'guides/hosting/platform',
'guides/examples',
],
items: ['about', 'architecture', 'guides/examples'],
},
{
type: 'category',
@@ -34,18 +29,7 @@ const sidebars = {
},
{
type: 'category',
label: 'Migrate to Supabase',
collapsed: true,
items: [
'guides/migrations/firebase-auth',
'guides/migrations/firestore-data',
'guides/migrations/firebase-storage',
'guides/migrations/heroku',
],
},
{
type: 'category',
label: 'Supabase CLI',
label: 'CLI',
collapsed: true,
items: [
'guides/cli',
@@ -195,6 +179,7 @@ const sidebars = {
label: 'Platform',
collapsed: true,
items: [
'guides/hosting/platform',
'guides/platform/disk-usage',
'guides/platform/logs',
'guides/platform/metrics',
@@ -209,6 +194,17 @@ const sidebars = {
collapsed: true,
items: ['guides/hosting/overview', 'guides/hosting/docker'],
},
{
type: 'category',
label: 'Migrate to Supabase',
collapsed: true,
items: [
'guides/migrations/firebase-auth',
'guides/migrations/firestore-data',
'guides/migrations/firebase-storage',
'guides/migrations/heroku',
],
},
{
type: 'category',
label: 'Integrations',
@@ -231,20 +227,6 @@ const sidebars = {
'guides/integrations/vercel',
],
},
{
type: 'category',
label: 'See Also',
collapsed: true,
items: [
'faq',
'handbook/contributing',
'handbook/supasquad',
'company/terms',
'company/privacy',
'company/aup',
'company/sla',
],
},
],
reference: [
{