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

docs: tweak postgresql compatibility blurbs #30451

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

kay-kim
Copy link
Contributor

@kay-kim kay-kim commented Nov 12, 2024

Small tweaks to Postgres compatibility "strive for compatibility" blurb

@kay-kim kay-kim requested a review from a team as a code owner November 12, 2024 20:13
doc/user/content/get-started/_index.md Outdated Show resolved Hide resolved
doc/user/content/get-started/_index.md Outdated Show resolved Hide resolved
leverage exciting new SQL patterns enabled by streaming like
[**Change Data Capture (CDC)**](/integrations/#databases),
[**temporal filters**](/sql/patterns/temporal-filters/), and [**subscriptions**](/sql/subscribe/).
You can interact with Materialize using SQL. You can build complex analytical
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
You can interact with Materialize using SQL. You can build complex analytical
The language used to interact with Materialize is **SQL**. You can build complex
analytical

Copy link
Contributor

Choose a reason for hiding this comment

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

"You can" makes it sound like you can use SQL, but you can also use something else.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How about "You interact with Materialize using SQL"? "The language used to interact ... is SQL" seems slightly awkward.

@@ -9,18 +9,13 @@ menu:
identifier: transform-overview
---

With Materialize, you can use SQL to transform, deliver, and act on
Copy link
Contributor

Choose a reason for hiding this comment

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

I wouldn't replace the blurb in this page. You could just link to the page above from "compatibility with the PostgreSQL dialect", rather than repeating the whole thing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I feel like users actually doing the transform would kind of need to know that repeating here can help - that is, we're hitting 2 different users in those pages.

Comment on lines 14 to 15
with a specific version of PostgreSQL. This allows Materialize to add the latest
PostgreSQL features even as some features of specific versions of PostgreSQL are
Copy link
Contributor

Choose a reason for hiding this comment

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

When talking about SQL, we should prefer to use the term "syntax" to "features" or "functionality". There's something to be said elsewhere about pgwire-compatibility that is unrelated (or, at least different) to SQL compatibility, too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There will be some one-off transgressions; e.g., will be adding a request a feature sentence ... and "request a syntax" seems clunky.

const offset = offsets.find((o) => o.id == id);
if (offset) $(window).scrollTop(offset.offset - 10);
else $(window).trigger("scroll");
$(window).trigger("scroll");
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Had to tweak this -- otherwise, it wouldn't scroll correctly to the bottom. The rewrite of the scroll logic is on my todo list - it's the highest of my non-content items. Fingers crossed that maybe in December.

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.

2 participants