docs icon indicating copy to clipboard operation
docs copied to clipboard

add PDP concepts overview

Open nikolasburk opened this issue 10 months ago • 6 comments

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

nikolasburk avatar May 02 '24 12:05 nikolasburk

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

vercel[bot] avatar May 02 '24 12:05 vercel[bot]

Absolute URL check

No absolute URLs to prisma.io/docs found.

github-actions[bot] avatar May 02 '24 12:05 github-actions[bot]

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 )##

github-actions[bot] avatar May 02 '24 12:05 github-actions[bot]

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.

github-actions[bot] avatar May 02 '24 12:05 github-actions[bot]

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

Images automagically compressed by Calibre's image-actions

Compression reduced images by 32.3%, saving 90.50 KB.

Filename Before After Improvement Visual comparison
static/img/platform/pdp-concepts.png 280.36 KB 189.87 KB -32.3% View diff

148 images did not require optimisation.

github-actions[bot] avatar May 06 '24 09:05 github-actions[bot]

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 avatar May 06 '24 17:05 mhessdev

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)

mhessdev avatar May 06 '24 17:05 mhessdev

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.

github-actions[bot] avatar May 10 '24 16:05 github-actions[bot]

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?

petradonka avatar May 13 '24 09:05 petradonka

Thanks for the ping @meletj and @petradonka!

I added redirects and update utm in this PR: https://github.com/prisma/docs/pull/5999

nikolasburk avatar May 13 '24 10:05 nikolasburk