Docs: Refresh dashboard/web app information#2893
Conversation
|
🚀 Preview deployed to https://docs.estuary.dev/pr-preview/pr-2893/ 📄 Changed pages: |
| For example, if you have a capture called `acmeCo/logistics/anvil-locations/source-postgres`, | ||
| you can find it by filtering for `acmeCo*source-postgres`. | ||
|
|
||
| **5:** Status indicator. Shows the status of the primary task [shard](/concepts/advanced/shards) that backs this capture. |
There was a problem hiding this comment.
I will leave this thought here - but applies to materializations as well.
I think we are technically doing some logic to "bubble" up shard status and it is not always just the primary task's status. I doubt we need to get to this level detail here though considering the average audience just needs to know what the colors mean.
There was a problem hiding this comment.
Interesting. I reworded this to be more general. If the status is an amalgamation, is there a reason that the dashboard message when hovering over active/green status is PRIMARY?
travjenkins
left a comment
travjenkins
left a comment
There was a problem hiding this comment.
This is awesome - and greatly needed.
Only called out the smallest of nit picks where some language tripped me up... but I was reading like a technical editor and not a user.
I agree we should work towards standardizing to dashboard for terminology.
LGTM - reviewed the changes through reading markdown and reviewing on the preview site. Did not deeply read the areas that are naturally repetitious.
2 participants
Description:
Our main source of information on navigating the dashboard currently lives in the Web App concept page. This page is outdated and tries to cram details about a lot of different dashboard pages into one long guide. "Concepts" is also not the first place someone would think to look for a usage guide; the introductory material in it would likely be a better fit higher up in the table of contents.
This PR makes a number of changes to try to address these issues by:
Still considering standardizing naming around the dashboard/web app/UI, though I don't fully commit in this PR. I'm leaning towards "dashboard" being the go-to, reserving "web application" or "UI" as less frequent variations when it's already clear we're talking about the dashboard.
Very tangentially related to #2839 - I wanted to get this in order beforehand since access control guides may end up linking back to the account access info in admin settings.
Documentation links affected:
Main changes are centered on the dashboard section in docs, as well as the web app concepts page.
Notes for reviewers:
Some of the content is kind of samey since the capture/collection/materialization pages are fairly similar. It's like that in the current version of the web app concept page, too, but let me know if it'd be better to try to consolidate some of that.