Docs: Fix links, flowctl dependency, and other clean up#2790
Docs: Fix links, flowctl dependency, and other clean up#2790
Conversation
|
jwhartley
left a comment
jwhartley
left a comment
There was a problem hiding this comment.
Approved. Have commented some potential additions but not blocking.
| * **Depth Zero:** Only selects top-level fields | ||
| * **Depth One:** Selects object fields with one degree of nesting | ||
| * **Depth Two:** Selects object fields with two degrees of nesting | ||
| * **Required Only:** Selects only required fields |
There was a problem hiding this comment.
Is it worth explaining what fields are required?
- the collection key / group by
- _meta/op
- flow_document (for standard updates, although as of recently it can excluded when using the no_flow_document feature flag)
There was a problem hiding this comment.
I'd previously received feedback that listing specific selection/rejection (or require/exclude) reasons for field selection could be confusing outside the context of the dashboard. If it'd be useful, I could add a short section explaining required fields, or simply refer the user to the dashboard for details. Let me know what you think.
There was a problem hiding this comment.
Ah I see, that is understandable. I've recently been moving more towards all info in the docs + cater for flowctl users as I'm thinking more about agents as users. It's a personal bias but I do think it's going to be more important. A short section explaining would be good IMHO, but I'm not overly fussed.
|
|
||
| ## Set Up Alerts in External Platforms | ||
|
|
||
| Beyond Estuary's built-in alerting capabilities, you can also configure your own alerts in platforms like Datadog and Grafana. |
There was a problem hiding this comment.
For this page, I think it's worth mentioning the email to slack capability Slack offers, since we mention it all the time to customers (both unprompted and if they ask if there's a slack integration): https://slack.com/intl/en-au/help/articles/206819278-Send-emails-to-Slack
| You can also find the source files on GitHub [here](https://go.estuary.dev/flowctl). | ||
|
|
||
| 2. Some flowctl commands, such as `flowctl generate`, require a Docker daemon to be running. | ||
| Make sure you have [Docker](https://www.docker.com/) installed to use these commands. |
There was a problem hiding this comment.
Tangential: do you know if flowctl gives an actionable error about installing docker, or this is an improvement we should also request?
There was a problem hiding this comment.
It's pretty clear the error's about Docker; it can just be a surprise that it's required once you get to that point. For example:
error=docker command ["create", …] failed: Cannot connect to the Docker daemon at unix:///Users/<user>/.docker/run/docker.sock. Is the docker daemon running?
2 participants
Description:
Rolls up some minor fixes and improvements to docs, including:
Documentation links affected:
Various
Notes for reviewers:
Thanks for reviewing!