docs: update the web app section to match current UI/UX a bit better #1165
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Adding spot for annotated screenshot of details pages
Updating the new left nav names
Updating the name portion of details Adding the stats title Adding annotations to collection spec
travjenkins
changed the title
travjenkins
commented
Aug 30, 2023
Comment on lines
18
to
+25
| * Creating end-to-end Data Flows: **capturing** data from source systems and **materializing** it to destinations. | ||
| * Creating, viewing, and editing individual captures and materializations. | ||
| * Monitor the amount of data being processed by the system. | ||
| * Viewing data **collections**. | ||
| * Viewing users and permissions. | ||
| * Granting permissions to other users. | ||
| * Authenticating with the flowctl CLI. | ||
| * Manage billing details. |
There was a problem hiding this comment.
Added some of the new capabilities in the UI
travjenkins
commented
Aug 30, 2023
Comment on lines
43
to
+44
| When you log into the web app, you land on the **Welcome** page. | ||
| There are four additional pages visible as tabs in the side navigation: **Captures**, **Collections**, **Materializations**, and **Admin**. | ||
| There are four additional pages visible as tabs in the side navigation: **Sources (captures)**, **Collections**, **Destinations (materializations)**, and **Admin**. |
There was a problem hiding this comment.
We've updated the left nav so throwing what entities each link represent in brackets.
travjenkins
commented
Aug 30, 2023
Comment on lines
+225
to
+227
| Fill out the **Endpoint Config** form and in the **Source Collections** section use the **Collection Selector** to map Flow collections to resources in the destination system. | ||
|
|
||
| Note that if you entered the workflow from the Captures page or after publishing a capture, collections will be pre-populated for you. |
There was a problem hiding this comment.
Adding in a mention of the "Source Collections" title to hope people connect the sections mentally.
Eventually I'd like to document this entire section
travjenkins
changed the title
oliviamiannone
approved these changes
Aug 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Updated the web app portion of the docs to reflect a more recent version of the application. Major changes include having docs for the details section and collections table now having row actions.
Workflow steps:
Go to the docs
Documentation links affected:
Should all just be within https://docs.estuary.dev/concepts/web-app/
Notes for reviewers:
Updated stuff - login page, the entity table docs, and some minor tweaks here and there.
New stuff - details sections
This change is