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

Improve Pulse docs: "What is Pulse?" and "Getting started" #5976

Merged
merged 37 commits into from
May 13, 2024

Conversation

nikolasburk
Copy link
Member

I made a couple of changes that I hope make it easier for people to understand what Pulse is, what value it provides and getting started with it.

Nothing too fundamental, just a few things I thought should be improved:

  • What is Pulse?
    • Added more structure/headings to the page
    • Laid out use case and features (based on the value messaging guide)
    • Update existing and add new illustrations (design tasks are here)
    • Adjusted and expanded on some of the existing explanations
  • Getting started
    • Clean up prerequisites
    • Divide step 1. into smaller steps to handhold the reader more
    • Change prisma.notification.subscribe() to prisma.user.subscribe() and add the corresponding Prisma schema in a tab
    • add step 3. to test the subscription
    • updated "Next steps" with more filter examples

FWIW: I didn't do that yet but I think we should also (in the future) instruct people to run prisma migrate in these instructions to really have a fully step-by-step tutorial that doesn't leave room for error

Copy link

vercel bot commented May 3, 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 2:12pm

Copy link
Contributor

github-actions bot commented May 3, 2024

Absolute URL check

No absolute URLs to prisma.io/docs found.

Copy link
Contributor

github-actions bot commented May 3, 2024

Redirect check

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

  • This PR does not change any pages in a way that would require a redirect.

Copy link
Contributor

github-actions bot commented May 3, 2024

Images automagically compressed by Calibre's image-actions

Compression reduced images by 34.3%, saving 95.58 KB.

Filename Before After Improvement Visual comparison
static/img/pulse/overview.png 185.94 KB 121.14 KB -34.8% View diff
static/img/pulse/unidirectional-data-flow.png 92.74 KB 61.96 KB -33.2% View diff

148 images did not require optimisation.

Copy link

cloudflare-workers-and-pages bot commented May 3, 2024

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0f6e6eb
Status: ✅  Deploy successful!
Preview URL: https://8019e494.docs-51g.pages.dev
Branch Preview URL: https://pulse-updates.docs-51g.pages.dev

View logs

Copy link
Member

@jharrell jharrell left a comment

Choose a reason for hiding this comment

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

Few minor changes and some questions

content/400-pulse/100-what-is-pulse.mdx Outdated Show resolved Hide resolved
content/400-pulse/100-what-is-pulse.mdx Outdated Show resolved Hide resolved
content/400-pulse/100-what-is-pulse.mdx Outdated Show resolved Hide resolved
content/400-pulse/100-what-is-pulse.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@petradonka petradonka left a comment

Choose a reason for hiding this comment

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

@nikolasburk, this is great, thanks so much for adding these details! 🙏

content/400-pulse/100-what-is-pulse.mdx Outdated Show resolved Hide resolved
content/400-pulse/100-what-is-pulse.mdx Outdated Show resolved Hide resolved
content/400-pulse/100-what-is-pulse.mdx Outdated Show resolved Hide resolved
content/400-pulse/100-what-is-pulse.mdx Show resolved Hide resolved
content/400-pulse/100-what-is-pulse.mdx Outdated Show resolved Hide resolved
content/400-pulse/200-getting-started.mdx Outdated Show resolved Hide resolved
content/400-pulse/200-getting-started.mdx Show resolved Hide resolved
content/400-pulse/200-getting-started.mdx Show resolved Hide resolved
content/400-pulse/200-getting-started.mdx Outdated Show resolved Hide resolved
content/400-pulse/200-getting-started.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented May 8, 2024

Images automagically compressed by Calibre's image-actions

Compression reduced images by 12.7%, saving 54.05 KB.

Filename Before After Improvement Visual comparison
static/img/pulse/overview.png 274.96 KB 247.18 KB -10.1% View diff
static/img/pulse/unidirectional-data-flow.png 151.05 KB 124.78 KB -17.4% View diff

148 images did not require optimisation.

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 4.6%, saving 4.06 KB.

Filename Before After Improvement Visual comparison
static/img/pulse/user-insert.png 88.28 KB 84.22 KB -4.6% View diff

150 images did not require optimisation.

@nikolasburk nikolasburk merged commit 165a58a into main May 13, 2024
9 of 11 checks passed
@nikolasburk nikolasburk deleted the pulse-updates branch May 13, 2024 08:57
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.

3 participants