Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add PDP concepts overview #5970

Merged
merged 60 commits into from
May 13, 2024
Merged

add PDP concepts overview #5970

merged 60 commits into from
May 13, 2024

Conversation

nikolasburk
Copy link
Member

@nikolasburk nikolasburk commented May 2, 2024

This PR introduces a number of changes to the PDP docs:

  • refactors "concepts" and move Workspaces, Projects and Environments out of the sidebar and puts all relevant information into About page
  • elaborates on Workspaces, Projects and Environments with simple language and gives examples of "typical" use/workflows
  • gives more context on billing with concrete examples
  • adds concrete instructions to configure the Accelerate connection pool size

Copy link

vercel bot commented May 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
docs ⬜️ Ignored (Inspect) Visit Preview May 7, 2024 6:25am

Copy link
Contributor

github-actions bot commented May 2, 2024

Absolute URL check

No absolute URLs to prisma.io/docs found.

Copy link
Contributor

github-actions bot commented May 2, 2024

Redirect check

This PR probably requires the following redirects to be added to static/_redirects:

/platform/concepts/workspaces /docs/##( TODO: Path of page that replaces deleted page )##
/platform/concepts/projects /docs/##( TODO: Path of page that replaces deleted page )##
/platform/concepts/environments /docs/##( TODO: Path of page that replaces deleted page )##
/platform/concepts /docs/##( TODO: Path of page that replaces deleted page )##

Copy link
Contributor

github-actions bot commented May 2, 2024

Images automagically compressed by Calibre's image-actions

Compression reduced images by 1.7%, saving 7.43 KB.

Filename Before After Improvement Visual comparison
static/img/platform/pdp-concepts.png 429.51 KB 422.08 KB -1.7% View diff

148 images did not require optimisation.

Copy link

cloudflare-pages bot commented May 2, 2024

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: a4c6461
Status: ✅  Deploy successful!
Preview URL: https://d67261c2.docs-51g.pages.dev
Branch Preview URL: https://pdp-concepts.docs-51g.pages.dev

View logs

content/300-accelerate/250-connection-pooling.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/300-accelerate/250-connection-pooling.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/50-support.mdx Outdated Show resolved Hide resolved
content/300-accelerate/250-connection-pooling.mdx Outdated Show resolved Hide resolved
content/300-accelerate/250-connection-pooling.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/50-support.mdx Show resolved Hide resolved
nikolasburk and others added 11 commits May 6, 2024 09:54
Co-authored-by: Nurul Sundarani <sundarani@prisma.io>
Co-authored-by: Nurul Sundarani <sundarani@prisma.io>
Co-authored-by: Petra Donka <donkapetra@gmail.com>
Co-authored-by: Petra Donka <donkapetra@gmail.com>
Co-authored-by: Petra Donka <donkapetra@gmail.com>
Co-authored-by: Petra Donka <donkapetra@gmail.com>
Co-authored-by: Petra Donka <donkapetra@gmail.com>
Co-authored-by: Petra Donka <donkapetra@gmail.com>
Co-authored-by: Petra Donka <donkapetra@gmail.com>
Co-authored-by: Petra Donka <donkapetra@gmail.com>
nikolasburk and others added 2 commits May 6, 2024 11:44
Co-authored-by: Petra Donka <donkapetra@gmail.com>
Co-authored-by: Petra Donka <donkapetra@gmail.com>
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Show resolved Hide resolved
content/500-platform/10-about.mdx Show resolved Hide resolved
content/500-platform/10-about.mdx Show resolved Hide resolved
@mhessdev
Copy link
Contributor

mhessdev commented May 6, 2024

Screenshot 2024-05-06 at 1 42 32 PM

I would possibly note what environment is default for a project. Does it have a name?

@mhessdev
Copy link
Contributor

mhessdev commented May 6, 2024

Maybe I missed it, but I'm not sure. I see something stating that you need a single API key for a single environment, even if that environment has both Prisma Pulse and Prisma Accelerate enabled. (although I might be wrong on that working)

content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
content/500-platform/10-about.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 9.8%, saving 5.92 KB.

Filename Before After Improvement Visual comparison
static/img/platform/pdp-concepts.png 60.64 KB 54.72 KB -9.8% View diff

148 images did not require optimisation.

@nikolasburk nikolasburk merged commit 6ead326 into main May 13, 2024
9 checks passed
@nikolasburk nikolasburk deleted the pdp-concepts branch May 13, 2024 08:09
@petradonka
Copy link
Contributor

Redirect check

This PR probably requires the following redirects to be added to static/_redirects:

/platform/concepts/workspaces /docs/##( TODO: Path of page that replaces deleted page )##
/platform/concepts/projects /docs/##( TODO: Path of page that replaces deleted page )##
/platform/concepts/environments /docs/##( TODO: Path of page that replaces deleted page )##
/platform/concepts /docs/##( TODO: Path of page that replaces deleted page )##

@nikolasburk, did we add these redirects?

In each workspace, you can:

- view and manage all projects (and their environments) in that workspace.
- manage billing, i.e. select a [subscription plan](https://prisma.io/pricing?utm_source=prisma-docs&utm_medium=docs-site), configure payment methods, or view the invoice history.
Copy link
Contributor

@meletj meletj May 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nikolasburk when you fix the redirects, can you also update the UTM here to have source=docs so we're consistent and medium=platform-docs? Thank you


- view and manage all environments in that project.

The number of project you can create in a workspace depends on the [subscription plan](https://prisma.io/pricing?utm_source=prisma-docs&utm_medium=docs-site) configured in that workspace.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above re: UTM


## Billing

The [subscription plan](https://prisma.io/pricing?utm_source=prisma-docs&utm_medium=docs-site) you select in your workspace determines how many projects and environments you can create in that workspace:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above re UTM

- if you subscribe to our **Pro** plan on the 15th day of a month, you'll only be charged the base plan price for the days left in that month.
- if you downgrade your subscription plan (e.g. from **Business** to **Pro**) after 10 days of a 30-day month, you'll be charged for 10 days of the base price of the **Business** plan and 20 days for the base price of the **Pro** plan.

Visit our [pricing page](https://prisma.io/pricing?utm_source=prisma-docs&utm_medium=docs-site) for more details.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same re: UTM

@nikolasburk
Copy link
Member Author

Thanks for the ping @meletj and @petradonka!

I added redirects and update utm in this PR: #5999

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants