Docs: Standardize Estuary product name #2562
Conversation
|
|
This looks fine to me. If there's anything left, we can do a second iteration. Moving from "flow" references to "dataflow" in specification files also makes sense to me as a further attempt to disambiguate, although that'd mean changing the yaml spec's as well so we'd need to bring that up with the engineering team. I'm happy to approve this as is, or was the plan to include any of those future changes in this PR as well? |
|
With a change like this, I think there's going to be cleanup efforts for a while. I don't think we need to wait for connector field descriptions, etc, to change before getting the main updates out. That said, what changes were you thinking would be needed for yaml specs? Ex. we can keep existing terminology like |
|
Yep, I agree and I wasn't thinking of any specific changes there, so this is good to go from my side. |
| You can interact with connectors using either Estuary's web application or the flowctl CLI. | ||
|
|
||
| ### Flow web application | ||
| ### Web application |
There was a problem hiding this comment.
Maybe not for this PR as web application is used in a lot of places. But we might want to look into just calling this the dashboard since that is how we usually talk about it internally.
There was a problem hiding this comment.
Definitely. That may end up being its own standardization task. We variously say "the web app," "the UI," "the dashboard," etc throughout our docs.
There was a problem hiding this comment.
I assume this is not a deeply binding document. So I assume this is safe. I'll also change the link to this document in UI as it says 'Estuary Flow'.
Description:
We variously call our service "Estuary," "Estuary Flow," or "Flow" throughout our docs and other resources. This PR is an attempt to standardize our language usage.
flow.yamlandflowctl.flow. I generally left the docs for these alone to match up with the user experience and avoid breakages. The "Data Flow" concept may also be able to explain many of these, though we may wish to update some connectors' spec schemas eventually.There are some other minor updates to language on the main README and docs landing page to match how we currently describe the platform. Other than that, I attempted to keep changes focused, though a few typo fixes may have made their way into the PR as well.
cc @SourabhEstuary for awareness
Documentation links affected:
Almost every docs page
Notes for reviewers:
The platform docs may warrant more attention than the connector docs for review. Since the connector references are fairly formulaic, as long as the most-used connectors (like Postgres, Snowflake, etc) are reviewed, other connector docs are likely to be similar.