Skip to content
This repository has been archived by the owner on Nov 12, 2024. It is now read-only.

Commit

Permalink
docs: upstream
Browse files Browse the repository at this point in the history
  • Loading branch information
planetscale-actions-bot committed Sep 25, 2023
1 parent 24eb097 commit 99788f6
Show file tree
Hide file tree
Showing 34 changed files with 37 additions and 37 deletions.
2 changes: 1 addition & 1 deletion docs/concepts/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ On the dashboard of every PlanetScale database is a diagram outlining the infras

When a new development branch is created, a single MySQL node is created along with a load balancer that handles connections to that node. This is reflected in the diagram of a development branch.

![Dev branch architecture](/assets/docs/concepts/architecture/dev-infra.png)
![Dev branch architecture {priority}](/assets/docs/concepts/architecture/dev-infra.png)

### Production branches

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/back-up-and-restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To view backups for all of your branches, go to your database backups page: `app

Once there, you'll find additional details about your backup history.

![View backups for your database](/assets/docs/concepts/back-up-and-restore/view-backups.png)
![View backups for your database {priority}](/assets/docs/concepts/back-up-and-restore/view-backups.png)

## Create manual backups

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/connection-strings.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ date: '2023-08-15'

1. To create a password, head to your database overview page at `https://app.planetscale.com/<ORGANIZATION>/<DATABASE_NAME>` and click on the "**Connect**" button.

![Database overview page](/assets/docs/concepts/connection-strings/connect-2.png)
![Database overview page {priority}](/assets/docs/concepts/connection-strings/connect-2.png)

2. On this dialog, click the `New password` button and you'll have the opportunity to select the branch to create a password for, pick a [password role](/docs/concepts/password-roles), and provide a recognizable name for the new credentials. Clicking `Create password` will then generate a **unique username and password pair** that can only be used to access the designated branch of your database. Take note of this password, as you won't be able to see it again.

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/database-sleeping.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ After a period of inactivity, free databases will enter 'sleep' mode. All data w

When a database on the [free Hobby plan](/docs/concepts/billing#planetscale-plans) is inactive for 7 days, the database will be enter sleep mode. When a database is sleeping, all data is backed up, but you **will not be able to connect to any branches on the database** until it has been woken up.

![PlanetScale dashboard overview page - Sleeping databases](/assets/docs/concepts/database-sleeping/databases.png)
![PlanetScale dashboard overview page - Sleeping databases {priority}](/assets/docs/concepts/database-sleeping/databases.png)

### What happens to my data?

Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/mfa.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ You can enable MFA for your user account under your PlanetScale account settings

2. Find the **Security** row and click the **"Setup multi-factor authentication"** button.

![Click the "Setup MFA" button](/assets/docs/concepts/mfa/setup.png)
![Click the "Setup MFA" button {priority}](/assets/docs/concepts/mfa/setup.png)

This will bring up a pop-up modal with a _QR code_ and some `recovery codes` that you will need to copy.

![Pop-up modal with QR code and recovery codes](/assets/docs/concepts/mfa/recovery-codes.png)
![Pop-up modal with QR code and recovery codes {priority}](/assets/docs/concepts/mfa/recovery-codes.png)

{% callout type="warning" %}
Recovery codes are the only account recovery method accepted when MFA is enabled. If you lose both your TOTP app and
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/password-roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ PlanetScale allows you to [create and manage passwords](/docs/concepts/connectio
1. Go to your database settings page.
2. Click "**Passwords**" > "**New password**".
3. Give it a name, select the role from the dropdown, select the branch, and click "**Generate password**".
![PlanetScale password roles](/assets/docs/concepts/password-roles/roles.png)
![PlanetScale password roles {priority}](/assets/docs/concepts/password-roles/roles.png)

Once a password is created, **its role cannot be changed**.

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/planetscale-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ subtitle: 'Use the PlanetScale workflow for branching databases, non-blocking sc
date: '2023-04-05'
---

![Diagram showing PlanetScale workflow](/assets/docs/planetscale-workflow.png)
![Diagram showing PlanetScale workflow {priority}](/assets/docs/planetscale-workflow.png)

## Serverless databases

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/read-only-regions.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This feature supports globally distributed applications by enabling your databas
1. In the [PlanetScale dashboard](https://app.planetscale.com), select the database you want to add a read-only region to.
2. Click on the production branch.
3. Click the "**Add region**" button.
![Add read-only region on production branch](/assets/docs/concepts/read-only-regions/branch-2.jpg)
![Add read-only region on production branch {priority}](/assets/docs/concepts/read-only-regions/branch-2.jpg)
4. Select the desired AWS region from the dropdown of [available regions](/docs/concepts/regions).
![Select read-only region on production branch](/assets/docs/concepts/read-only-regions/form.png)
5. Click "**Add region**" and wait for your data to finish initially replicating across regions.
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/web-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The PlanetScale web console can be used to query to any database branch; however

To access the web console, navigate to a database, and click on the "Console" tab in the page navigation. From here, you can select which branch you'd like to connect to by selecting it in the dropdown and clicking "Connect".

![Web console branch selection](/assets/docs/concepts/web-console/web-console-branch-selection.png)
![Web console branch selection {priority}](/assets/docs/concepts/web-console/web-console-branch-selection.png)

You can also access the web console directly by adding `/console` to the URL from any database branch page,
`app.planetscale.com/<org>/<database>/<branch>/console`.
Expand Down
2 changes: 1 addition & 1 deletion docs/devops/intro-to-the-eight-phases-of-devops.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ date: '2023-03-13'

DevOps is typically broken down into eight distinguished phases as an operational model. The phases operate in a continuous loop, with each phase providing value to the phase ahead of it as shown in the following diagram in the gray text:

![The eight phases of DevOps](/assets/docs/devops/intro-to-the-eight-phases-of-devops/devops-cycle.png)
![The eight phases of DevOps {priority}](/assets/docs/devops/intro-to-the-eight-phases-of-devops/devops-cycle.png)

This document will act as a brief introduction to these phases, with a summary of how various PlanetScale features apply to each phase. Links to the relevant PlanetScale feature documentation will be provided, and additional resources such as practical tutorials with specific products and frameworks will be included as they are built.

Expand Down
2 changes: 1 addition & 1 deletion docs/devops/the-operate-phase-of-devops.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Now that everything is deployed into production and confirmed working, the opera

All PlanetScale tiers eliminate the need to maintain your MySQL infrastructure by allowing us to do it for you. Additionally, any production branches automatically have failover replicas so even if something fails with one instance internally, a backup is always available to take over while any necessary maintenance is performed by our teams.

![Infrastructure UI card](/assets/docs/devops/the-operate-phase-of-devops/infra-2.png)
![Infrastructure UI card {priority}](/assets/docs/devops/the-operate-phase-of-devops/infra-2.png)

On top of reducing the necessity of maintaining a MySQL environment, PlanetScale offers additional features that can simplify the jobs of the operations teams.

Expand Down
2 changes: 1 addition & 1 deletion docs/devops/versioned-schema-migrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you're already well versed in versioned schema migrations and just want to se

The following example uses the default Laravel example application with the `artisan` command to perform versioned migrations. When the application is scaffolded, a `database/migrations` folder will be created within the project that contains a base set of migration scripts.

![The default migrations of the Laravel example app](/assets/docs/devops/versioned-migrations/laravel-migrations.png)
![The default migrations of the Laravel example app {priority}](/assets/docs/devops/versioned-migrations/laravel-migrations.png)

Here are the contents of that first file. It is using PHP to define the structure of a table. When read by `artisan`, it will be converted to the DDL that is required to create the same structure in MySQL.

Expand Down
2 changes: 1 addition & 1 deletion docs/imports/aws-rds-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You’ll also need to gather the following pieces of information from the AWS Co

The endpoint address and port number are located in the database view under “**Connectivity & security”**.

![The Connectivity & security tab of the database in RDS.](/assets/docs/imports/aws-rds-migration-guide/the-connectivity-and-security-tab-of-the-database-in-rds.png)
![The Connectivity & security tab of the database in RDS. {priority}](/assets/docs/imports/aws-rds-migration-guide/the-connectivity-and-security-tab-of-the-database-in-rds.png)

The master username can be located under the “**Configuration”** tab. The master password will be the password used when the database was first created.

Expand Down
4 changes: 2 additions & 2 deletions docs/imports/azure-database-for-mysql-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ Before you can perform the migration, you’ll need to gather the following info

The server name and admin login name can be located on the **Overview** tab of the MySQL instance in Azure.

![The server name and server admin login name located in the Azure dashboard.](/assets/docs/imports/azure-database-for-mysql-migration-guide/the-server-name-and-server-admin-login-name-located-in-the-azure-dashboard.png)
![The server name and server admin login name located in the Azure dashboard. {priority}](/assets/docs/imports/azure-database-for-mysql-migration-guide/the-server-name-and-server-admin-login-name-located-in-the-azure-dashboard.png)

The server admin password is the same password you set when initially creating the database instance.

To view your available databases, select the **Databases** tab from the sidebar.

![The databases tab of the Azure dashboard.](/assets/docs/imports/azure-database-for-mysql-migration-guide/the-databases-tab-of-the-azure-dashboard.png)
![The databases tab of the Azure dashboard. {priority}](/assets/docs/imports/azure-database-for-mysql-migration-guide/the-databases-tab-of-the-azure-dashboard.png)

## Configure firewall rules

Expand Down
2 changes: 1 addition & 1 deletion docs/imports/database-imports.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To import an existing database into PlanetScale:
Importing a database will **not** count towards your `read` or `write` usage.
{% /callout %}

![Select name and region for new database import](/assets/docs/imports/database-imports/form.png)
![Select name and region for new database import {priority}](/assets/docs/imports/database-imports/form.png)

5. Fill in the following connection values with information from your existing hosted database:

Expand Down
2 changes: 1 addition & 1 deletion docs/imports/digitalocean-database-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Before you can start migrating your database, you’ll also need to collect the

Most of this information is located on the landing page of your cluster.

![The Overview of the database cluster.](/assets/docs/imports/digitalocean-database-migration-guide/the-overview-of-the-database-cluster.png)
![The Overview of the database cluster. {priority}](/assets/docs/imports/digitalocean-database-migration-guide/the-overview-of-the-database-cluster.png)

You can view the list of databases in the "**Users & Databases**" tab. This article will use the default database created when the cluster was initialized, named `defaultdb`.

Expand Down
2 changes: 1 addition & 1 deletion docs/imports/gcp-cloudsql-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You’ll also need to gather the following pieces of information from the GCP Co

The public IP address can be found in the **Overview tab** of your CloudSQL cluster under the **Connect to this instance** section.

![The GCP CloudSQL console with the IP address highlighted.](/assets/docs/imports/gcp-cloudsql-migration-guide/the-gcp-cloudsql-console-with-the-ip-address-highlighted.png)
![The GCP CloudSQL console with the IP address highlighted. {priority}](/assets/docs/imports/gcp-cloudsql-migration-guide/the-gcp-cloudsql-console-with-the-ip-address-highlighted.png)

A list of your databases can be found in the **Databases** tab. In this guide, we’ll be using the `tasksdb` database.

Expand Down
2 changes: 1 addition & 1 deletion docs/imports/import-tool-migration-addresses.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This IP reference guide is meant to be used in combination with our
"Migration guides" in the left nav.
{% /callout %}

![The New database section of the Import database tool.](/assets/docs/imports/import-tool-migration-addresses/region.png)
![The New database section of the Import database tool. {priority}](/assets/docs/imports/import-tool-migration-addresses/region.png)

{% table %}

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/datadog.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ PlanetScale can push metrics to Datadog to assist your team with understanding y

Once complete, a "PlanetScale" dashboard will be available with incoming metrics from PlanetScale.

![Image of the PlanetScale Default Dashboard in Datadog showing overview metrics, table and row breakdowns, info about connections, and query rates](/assets/docs/integrations/datadog/dashboard.png)
![Image of the PlanetScale Default Dashboard in Datadog showing overview metrics, table and row breakdowns, info about connections, and query rates {priority}](/assets/docs/integrations/datadog/dashboard.png)

## Metrics We Collect

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/hightouch.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ If you wish to sync data from your PlanetScale database to another system, you

In Hightouch, start by selecting **"Sources"** from the sidebar.

![Sources](/assets/docs/integrations/hightouch/sources.png)
![Sources {priority}](/assets/docs/integrations/hightouch/sources.png)

Click **"Add Source"**.

Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/stitch.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ into Stitch via [Stitch Import API](https://www.stitchdata.com/docs/developers/i
1. Sign up for a [StitchData](https://app.stitchdata.com/signup) account
2. Once you've signed up, create an Integration by clicking on **Add Integration**.
3. On the marketplace screen, type in **import** to narrow the list down to the **Import API**
![Add Stitch Integration](/assets/docs/integrations/stitch/integration.png)
![Add Stitch Integration {priority}](/assets/docs/integrations/stitch/integration.png)
4. On the next screen, configure your integration name and destination.
![Configure Stitch Integration](/assets/docs/integrations/stitch/configure.png)
![Configure Stitch Integration {priority}](/assets/docs/integrations/stitch/configure.png)
5. Once the integration is created, save the access token for use with the PlanetScale tap.
![Save Stitch API Token](/assets/docs/integrations/stitch/api-token.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Since PlanetScale [does not support foreign key constraints](/docs/learn/operati

The following examples will use the concept of a recipe manager with the following schema. Samples will be provided in SQL, so they are relatively universal regardless of the language or framework used.

![A sample recipes database schema.](/assets/docs/learn/strategies-for-maintaining-referential-integrity/diagram.svg)
![A sample recipes database schema. {priority}](/assets/docs/learn/strategies-for-maintaining-referential-integrity/diagram.svg)

The same scenario will be used for each suggestion below: deleting a recipe and its associated records.

Expand Down
2 changes: 1 addition & 1 deletion docs/prisma/prisma-data-platform-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If you're importing, click "**Import a Prisma repository**", and then select the

Make sure your imported project has a `schema.prisma` file. You can specify the path of the file in the "**Prisma Schema path**" input box. This file must be relative to the repository root.

![Prisma Data Platform project configuration](/assets/docs/tutorials/prisma-data-platform-integration/project.png)
![Prisma Data Platform project configuration {priority}](/assets/docs/tutorials/prisma-data-platform-integration/project.png)

## Select a template

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/planetscale-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ date: '2022-08-01'

Make sure to first [set up your PlanetScale developer environment](/docs/concepts/planetscale-environment-setup). Once you've installed the `pscale` CLI, you can interact with PlanetScale and manage your databases straight from the command line.

![PlanetScale CLI](/assets/docs/reference/planetscale-cli/cli.png)
![PlanetScale CLI {priority}](/assets/docs/reference/planetscale-cli/cli.png)

Ready to take these commands for a run on the terminal?

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/aws-lambda-connection-strings.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Once your database has finished initializing, you'll need to enable the web cons

Now, access the console of the main branch by clicking "**Console**", then "**Connect**".

![The console](/assets/docs/tutorials/aws-lambda-connection-strings/console-3.png)
![The console {priority}](/assets/docs/tutorials/aws-lambda-connection-strings/console-3.png)

Create a simple table & insert some data using the following script:

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/connect-any-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ There are two ways to generate a new username and password for your branch:
2. Click "**Connect**".
3. Select the applicable language from the "**Connect with**" dropdown or choose "General".

![Credentials to connect to PlanetScale](/assets/docs/tutorials/connect-any-application/credentials-2.png)
![Credentials to connect to PlanetScale {priority}](/assets/docs/tutorials/connect-any-application/credentials-2.png)

4. If the password isn't visible, click "New password".
5. Copy the credentials.
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/connect-mysql-gui.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To connect to a PlanetScale database, you'll need four pieces of information:

The easiest way to gather this information is by accessing the branch of the database you wish to connect to and selecting the **"Connect"** button from the **"Overview"** tab.

![Open the Connect modal.](/assets/docs/tutorials/connect-mysql-gui/connect.png)
![Open the Connect modal. {priority}](/assets/docs/tutorials/connect-mysql-gui/connect.png)

In the **Connect** modal, select **"General"** under the **Connect with** options. This will display the connection details as a list instead of a language or framework-specific connection string.

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/connect-php-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Already have a PHP application and just want to connect to PlanetScale? Check ou

This guide uses [a simple PHP app](https://github.com/planetscale/php-example) that displays a list of products stored in a PlanetScale database. If you have an existing application, you can also use that.

![PHP sample application homepage](/assets/docs/tutorials/connect-php-app/example.png)
![PHP sample application homepage {priority}](/assets/docs/tutorials/connect-php-app/example.png)

1. Clone the starter PHP application:

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/deploy-a-django-app-to-heroku.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This article will make use of the [django-example GitHub repository](https://git

It’s important to store the connection details for the PlanetScale database in **Config Vars** in Heroku so they are properly secured. These details can be obtained from the PlanetScale dashboard by clicking the "**Connect**" button.

![The location of the “Connect” button in the PlanetScale dashboard.](/assets/docs/tutorials/deploy-a-django-app-to-heroku/database-2.png)
![The location of the “Connect” button in the PlanetScale dashboard. {priority}](/assets/docs/tutorials/deploy-a-django-app-to-heroku/database-2.png)

In the following modal, choose Django from the “Connect with” dropdown. The .env tab will show all of the Config vars that need to be set up in Heroku. Take note of these and head to the Heroku dashboard.

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/deploy-to-netlify.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This doc is intended for users that are manually storing a connection string in
2. Click "**Connect**".
3. Select the framework you're using from the "**Connect with**" dropdown. This will give you the exact environment variable names you need for your selected framework. If your framework is not listed, choose "General".

![PlanetScale dashboard connect modal](/assets/docs/tutorials/deploy-to-netlify/prisma-2.png)
![PlanetScale dashboard connect modal {priority}](/assets/docs/tutorials/deploy-to-netlify/prisma-2.png)

4. If the password is blurred, click "New password" to generate new credentials.
5. Keep this page open, as you'll need to copy these to Netlify momentarily.
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/deploy-to-vercel.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ It will cover two options:
2. Click "**Connect**".
3. Select the framework you're using from the "**Connect with**" dropdown. This will give you the exact environment variable names you need for your selected framework. If your framework is not listed, choose "General".

![PlanetScale dashboard connect modal](/assets/docs/tutorials/deploy-to-vercel/prisma-2.png)
![PlanetScale dashboard connect modal {priority}](/assets/docs/tutorials/deploy-to-vercel/prisma-2.png)

4. If the password is blurred, click "New password" to generate new credentials.
5. Keep this page open, as you'll need to copy these to Vercel momentarily.
Expand Down
Loading

0 comments on commit 99788f6

Please sign in to comment.