From 992bccd785ae840f795b14e26394f9776d134872 Mon Sep 17 00:00:00 2001 From: PlanetScale Actions Bot Date: Thu, 18 Jan 2024 16:44:39 +0000 Subject: [PATCH] docs: upstream https://github.com/planetscale/www/commit/f67bfdf29c9bb94974e192830fa04a6d9e466ce8 --- docs/navigation/standard.md | 409 ++++++++++++++++++++++++++++++++++++ 1 file changed, 409 insertions(+) create mode 100644 docs/navigation/standard.md diff --git a/docs/navigation/standard.md b/docs/navigation/standard.md new file mode 100644 index 00000000..86c5735e --- /dev/null +++ b/docs/navigation/standard.md @@ -0,0 +1,409 @@ +--- +- label: 'Getting started' + icon: 'gettingStarted' + items: + - label: 'What is PlanetScale' + slug: '/docs/concepts/what-is-planetscale' + - label: 'PlanetScale workflow' + slug: '/docs/concepts/planetscale-workflow' + - label: 'Step-by-step guide' + slug: '/docs/tutorials/planetscale-quick-start-guide' + - label: 'Selecting a region' + slug: '/docs/concepts/regions' + - label: 'PlanetScale architecture' + slug: '/docs/concepts/architecture' + - label: 'MySQL compatibility' + slug: '/docs/reference/mysql-compatibility' + +- label: 'Importing a database' + icon: 'imports' + items: + - label: 'Database import tool' + items: + - label: 'Database imports' + slug: '/docs/imports/database-imports' + - label: 'Import tool public IP addresses' + slug: '/docs/imports/import-tool-migration-addresses' + - label: 'Import tool user permissions' + slug: '/docs/imports/import-tool-user-requirements' + - label: 'Migration guides' + items: + - label: 'Amazon Aurora' + slug: '/docs/imports/amazon-aurora-migration-guide' + - label: 'Amazon RDS' + slug: '/docs/imports/aws-rds-migration-guide' + - label: 'Azure' + slug: '/docs/imports/azure-database-for-mysql-migration-guide' + - label: 'Digital Ocean' + slug: '/docs/imports/digitalocean-database-migration-guide' + - label: 'GCP CloudSQL' + slug: '/docs/imports/gcp-cloudsql-migration-guide' + - label: 'MariaDB' + slug: '/docs/imports/mariadb-migration-guide' + +- label: 'Reading and writing data' + icon: 'readsWrites' + items: + - label: 'Connecting to PlanetScale' + items: + - label: 'Connect any app' + slug: '/docs/tutorials/connect-any-application' + - label: 'Connect a MySQL GUI' + slug: '/docs/tutorials/connect-mysql-gui' + - label: 'Connection strings' + slug: '/docs/concepts/connection-strings' + - label: 'Network latency' + slug: '/docs/concepts/network-latency' + - label: 'Querying PlanetScale' + items: + - label: 'Web console' + slug: '/docs/concepts/web-console' + - label: 'Replicas' + slug: '/docs/concepts/replicas' + - label: 'Tutorials' + items: + - label: 'AWS Lambda' + slug: '/docs/tutorials/aws-lambda-connection-strings' + - label: 'Django' + slug: '/docs/tutorials/connect-django-app' + - label: 'Golang' + items: + - label: 'Go quickstart' + slug: '/docs/tutorials/connect-golang-app' + - label: 'Gorm' + slug: '/docs/tutorials/connect-go-gorm-app' + - label: 'Next.js' + items: + - label: 'Next.js quickstart' + slug: '/docs/tutorials/connect-nextjs-app' + - label: 'Next.js and Netlify template' + slug: '/docs/tutorials/nextjs-planetscale-netlify-template' + - label: 'Deploy to Vercel' + slug: '/docs/tutorials/deploy-to-vercel' + - label: 'Deploy to Netlify' + slug: '/docs/tutorials/deploy-to-netlify' + - label: 'Node.js' + slug: '/docs/tutorials/connect-nodejs-app' + - label: 'PHP' + items: + - label: 'PHP quickstart' + slug: '/docs/tutorials/connect-php-app' + - label: 'Laravel quickstart' + slug: '/docs/tutorials/connect-laravel-app' + - label: 'Symfony quickstart' + slug: '/docs/tutorials/connect-symfony-app' + - label: 'Prisma' + items: + - label: 'Prisma quickstart' + slug: '/docs/prisma/prisma-quickstart' + - label: 'Automatic Prisma migrations' + slug: '/docs/prisma/automatic-prisma-migrations' + - label: 'Serverless driver with Prisma' + slug: '/docs/tutorials/planetscale-serverless-driver-prisma-example' + - label: 'Prisma best practices' + slug: '/docs/prisma/prisma-best-practices' + - label: 'Ruby on Rails' + items: + - label: 'Ruby on Rails quickstart' + slug: '/docs/concepts/connect-rails-app' + - label: 'Automatic Rails migrations' + slug: '/docs/tutorials/automatic-rails-migrations' + - label: 'Deploy your app' + items: + - label: 'Deploy to Netlify' + slug: '/docs/tutorials/deploy-to-netlify' + - label: 'Deploy to Vercel' + slug: '/docs/tutorials/deploy-to-vercel' + - label: 'Next.js and Netlify template' + slug: '/docs/tutorials/nextjs-planetscale-netlify-template' + - label: 'Deploy a Django app to Heroku' + slug: '/docs/tutorials/deploy-a-django-app-to-heroku' + - label: 'Serverless JavaScript driver' + items: + - label: 'Using the serverless driver' + slug: '/docs/tutorials/planetscale-serverless-driver' + - label: 'Node.js example' + slug: '/docs/tutorials/planetscale-serverless-driver-node-example' + - label: 'Prisma example' + slug: '/docs/tutorials/planetscale-serverless-driver-prisma-example' + - label: 'Integrations' + items: + - label: 'Cloudflare Workers' + slug: '/docs/integrations/cloudflare-workers' + - label: 'Netlify' + slug: 'https://docs.netlify.com/integrations/planetscale-integration/' + - label: 'Vercel' + slug: '/docs/tutorials/deploy-to-vercel#deploy-with-the-planetscale-vercel-integration' + +- label: 'Making schema changes' + icon: 'schemaChanges' + items: + - label: 'Non-blocking schema changes' + slug: '/docs/concepts/nonblocking-schema-changes' + - label: 'Safe migrations' + slug: '/docs/concepts/safe-migrations' + - label: 'Branching' + items: + - label: 'Using branches' + slug: '/docs/concepts/branching' + - label: 'Data Branching®' + slug: '/docs/concepts/data-branching' + - label: 'Deploy requests' + items: + - label: 'Using deploy requests' + slug: '/docs/concepts/deploy-requests' + - label: 'Schema changes' + items: + - label: 'How to make different types of schema changes' + slug: '/docs/learn/how-to-make-different-types-of-schema-changes' + - label: 'Handling table and column renames' + slug: '/docs/learn/handling-table-and-column-renames' + - label: 'Change single unique key' + slug: '/docs/learn/change-single-unique-key' + - label: 'Foreign key constraints' + items: + - label: 'Foreign key constraints support' + slug: '/docs/concepts/foreign-key-constraints' + - label: 'Operating without foreign key constraints' + slug: '/docs/learn/operating-without-foreign-key-constraints' + +- label: 'Monitoring your database' + icon: 'monitor' + items: + - label: 'Query Insights' + slug: '/docs/concepts/query-insights' + - label: 'Audit log' + slug: '/docs/concepts/audit-log' + - label: 'Integrations' + items: + - label: 'Datadog' + slug: '/docs/integrations/datadog' + +- label: 'Backing up your database' + icon: 'backup' + items: + - label: 'Back up and restore' + slug: '/docs/concepts/back-up-and-restore' + +- label: 'Scaling your database' + icon: 'scale' + items: + - label: 'Sharding with PlanetScale' + slug: '/docs/concepts/sharding' + - label: 'Read-only regions' + slug: '/docs/concepts/read-only-regions' + - label: 'PlanetScale system limits' + slug: '/docs/reference/planetscale-system-limits' + +- label: 'Caching queries' + icon: 'cache' + items: + - label: 'PlanetScale Boost' + items: + - label: 'Query caching with PlanetScale Boost' + slug: '/docs/concepts/query-caching-with-planetscale-boost' + - label: 'How to use PlanetScale Boost' + slug: '/docs/concepts/how-to-use-planetscale-boost' + - label: 'When to use PlanetScale Boost' + slug: '/docs/concepts/when-to-use-planetscale-boost' + - label: 'Language-specific guides' + items: + - label: 'Laravel guide' + slug: '/docs/tutorials/laravel-boost-guide' + - label: 'Ruby on Rails guide' + slug: '/docs/tutorials/rails-boost-guide' + - label: 'Go guide' + slug: '/docs/tutorials/go-boost-guide' + - label: 'Prisma guide' + slug: '/docs/tutorials/prisma-boost-guide' + - label: 'Node.js guide' + slug: '/docs/tutorials/node-boost-guide' + - label: 'Serverless JavaScript driver guide' + slug: '/docs/tutorials/serverless-driver-boost-guide' + +- label: 'Security and access' + icon: 'security' + items: + - label: 'PlanetScale security and compliance overview' + slug: '/docs/concepts/security' + - label: 'Database security' + items: + - label: 'Connection strings' + slug: '/docs/concepts/connection-strings' + - label: 'Secure connections' + slug: '/docs/concepts/secure-connections' + - label: 'Password roles' + slug: '/docs/concepts/password-roles' + - label: 'Account access' + items: + - label: 'Authentication methods' + slug: '/docs/concepts/authentication-methods' + - label: 'Multi-factor authentication' + slug: '/docs/concepts/mfa' + - label: 'Account password security' + slug: '/docs/concepts/account-password-security' + - label: 'Security log' + slug: '/docs/concepts/security-log' + - label: 'Organization access' + items: + - label: 'Access control' + slug: '/docs/concepts/access-control' + - label: 'Audit log' + slug: '/docs/concepts/audit-log' + - label: 'Teams' + slug: '/docs/concepts/teams' + - label: 'Single sign-on' + slug: '/docs/concepts/sso' + +- label: 'API' + icon: 'api' + items: + - label: 'API and OAuth applications' + slug: '/docs/concepts/planetscale-api-oauth-applications' + - label: 'PlanetScale API' + items: + - label: 'API reference' + slug: 'https://api-docs.planetscale.com/reference/getting-started-with-planetscale-api' + - label: 'Service tokens' + slug: '/docs/concepts/service-tokens' + - label: 'Webhooks in PlanetScale' + items: + - label: 'Setting up webhooks' + slug: '/docs/concepts/webhooks' + - label: 'Webhook events reference' + slug: '/docs/reference/webhook-events' + +- label: 'pscale CLI' + icon: 'cli' + items: + - label: 'CLI overview' + slug: '/docs/reference/planetscale-cli' + - label: 'Using the pscale CLI' + items: + - label: 'Setting up CLI environment' + slug: '/docs/concepts/planetscale-environment-setup' + - label: 'Service tokens' + slug: '/docs/concepts/service-tokens' + - label: 'CLI command reference' + items: + - label: 'api' + slug: '/docs/reference/cli-api' + - label: 'audit-log' + slug: '/docs/reference/audit-log' + - label: 'auth' + slug: '/docs/reference/auth' + - label: 'backup' + slug: '/docs/reference/backup' + - label: 'branch' + slug: '/docs/reference/branch' + - label: 'completion' + slug: '/docs/reference/completion' + - label: 'connect' + slug: '/docs/reference/connect' + - label: 'database' + slug: '/docs/reference/database' + - label: 'deploy-request' + slug: '/docs/reference/deploy-request' + - label: 'org' + slug: '/docs/reference/org' + - label: 'password' + slug: '/docs/reference/password' + - label: 'ping' + slug: '/docs/reference/ping' + - label: 'region' + slug: '/docs/reference/region' + - label: 'service-token' + slug: '/docs/reference/service-token' + - label: 'shell' + slug: '/docs/reference/shell' + - label: 'signup' + slug: '/docs/reference/signup' + +- label: 'Using CI/CD with your database' + icon: 'ciCd' + items: + - label: 'GitHub Actions' + items: + - label: 'Overview' + slug: '/docs/devops/github-actions' + - label: 'Create branch' + slug: '/docs/devops/create-branch-action' + - label: 'Create branch password' + slug: '/docs/devops/create-branch-password-action' + - label: 'Create deploy request' + slug: '/docs/devops/create-deploy-request-action' + - label: 'Deploy deploy request' + slug: '/docs/devops/deploy-deploy-request-action' + - label: 'Service tokens' + slug: '/docs/concepts/service-tokens' + +- label: 'Extracting data from your database' + icon: 'extract' + items: + - label: 'PlanetScale Connect' + items: + - label: 'Overview' + slug: '/docs/concepts/planetscale-connect' + - label: 'Airbyte' + slug: '/docs/integrations/airbyte' + - label: 'Fivetran' + slug: '/docs/integrations/fivetran' + - label: 'Hightouch' + slug: '/docs/integrations/hightouch' + - label: 'Stitch' + slug: '/docs/integrations/stitch' + +- label: 'PlanetScale for Enterprises' + icon: 'enterprise' + items: + - label: 'PlanetScale Managed' + items: + - label: 'PlanetScale Managed overview' + slug: '/docs/enterprise/managed/overview' + - label: 'AWS' + items: + - label: 'Overview' + slug: '/docs/enterprise/managed/aws/overview' + - label: 'Set up PlanetScale Managed' + slug: '/docs/enterprise/managed/aws/getting-started' + - label: 'Set up AWS PrivateLink' + slug: '/docs/enterprise/managed/aws/privatelink' + - label: 'Back up and restore' + slug: '/docs/enterprise/managed/aws/back-up-and-restore' + - label: 'GCP' + items: + - label: 'Overview' + slug: '/docs/enterprise/managed/gcp/overview' + - label: 'Set up PlanetScale Managed' + slug: '/docs/enterprise/managed/gcp/getting-started' + - label: 'Set up GCP Private Service Connect' + slug: '/docs/enterprise/managed/gcp/private-service-connect' + - label: 'Back up and restore' + slug: '/docs/enterprise/managed/gcp/back-up-and-restore' + - label: 'Security and access' + items: + - label: 'User management' + slug: '/docs/enterprise/managed/user-management' + - label: 'Cloud accounts and contents' + slug: '/docs/enterprise/managed/cloud-accounts-and-contents' + - label: 'Data requests' + slug: '/docs/enterprise/managed/data-requests' + +- label: 'Plans and billing' + icon: 'plans' + items: + - label: 'Plans' + items: + - label: 'PlanetScale plans' + slug: '/docs/concepts/planetscale-plans' + - label: 'Deployment options' + slug: '/docs/concepts/deployment-options' + - label: 'PlanetScale support plans' + slug: '/docs/support/support-overview' + - label: 'Database sleeping for Hobby plans' + slug: '/docs/concepts/database-sleeping' + - label: 'Billing' + items: + - label: 'Billing' + slug: '/docs/concepts/billing' +---