(DOCSP-7512) Document new UI for Favorite Connections #204
Conversation
There was a problem hiding this comment.
Just some small comments. Also, I can't see this change in GitHub because I don't think you touched these files but we say twice "Once you save your favorite connection, Compass displays the connection in the Favorites section in the left navigation." and it looks like it's currently nested under one of the steps. Can we pull that blurb and the image below it out of the step file so it isn't indented? This applies to both "Save from Connect Screen" and "Save after Connecting to a Deployment"
| :figwidth: 600px | ||
| :alt: Saved Favorite Connection | ||
|
|
||
| You can click the :icon-fa5:`ellipsis-h` button on a Favorite |
There was a problem hiding this comment.
This reads a little awkwardly, maybe
To :guilabel:`Copy` or :guilabel:`Remove` a Favorite Connection, hover over the target
collection and click the icon-fa5:`ellipsis-h` button.
Then, I think it'd be a bit easier to read if when we describe the behavior for Copy / Remove we make each its own bullet point.
| the link at the top-right of the form. | ||
|
|
||
| When you make any change to a connection, a dialog will appear at the | ||
| bottom of the form with options :guilabel:`[discard]` and |
There was a problem hiding this comment.
I know they have brackets in the UI but this looks not great. I think just doing
:guilabel:`Discard`
:guilabel:`Save Changes`
is fine
| --- | ||
| title: Click :guilabel:`Save Favorite` at the bottom of the form. | ||
| title: Click :guilabel:`[save changes]` when you are finished making |
There was a problem hiding this comment.
I think we can remove "when you are finished making changes". We told them to make changes in the previous step. Also ditto re this text formatting.
| level: 4 | ||
| ref: make-connection-changes | ||
| content: | | ||
| You can toggle the form layout between :guilabel:`Fill in connection |
There was a problem hiding this comment.
This paragraph feels a little random. I don't think we need it here.
|
Ready for another round of feedback - |
| --- | ||
| title: Click :guilabel:`Delete Favorite` at the bottom of the form. | ||
| title: Click :guilabel:`Remove` from the dropdown menu. | ||
| level: 4 | ||
| ref: click-delete | ||
| content: | | ||
| |compass| removes the connection from the :guilabel:`Favorites` list |
There was a problem hiding this comment.
Can we make this |compass-short|? Ditto for the |compass| which is the very first word of this page.
| @@ -1,17 +1,24 @@ | |||
| title: Click the desired connection under :guilabel:`Favorites` to | |||
| the left of the :guilabel:`Connect to Host` form. | |||
| title: Click on the desired connection under :guilabel:`Favorites` | |||
There was a problem hiding this comment.
I'd remove "on". It's not needed.
| @@ -1,25 +1,32 @@ | |||
| title: Locate the desired connection under :guilabel:`Favorites` | |||
| in the left navigation. | |||
| title: Click on the desired connection under :guilabel:`Favorites` | |||
There was a problem hiding this comment.
Ditto here re "on". Just say "Click the desired connection"
51ad3bf
to
9f0b2bd
Compare
Ticket
Staged view
Note: the ticket mentions the ability to "export / share favorite connections as JSON," but it looks like that feature hasn't made its way into the product yet. It doesn't exist on Compass version 1.20.0-beta.9 and the work was not included in the engineering epic.