DOCSP-34569 Bulk Update Task Page #580

ianf-mongodb · 2023-11-20T15:15:05Z

DESCRIPTION

Adding task page for the multiple update document workflow in Compass. This PR also includes a screenshot update for the query bar on the favorite query view page. It also includes additional context on the favorite queries page, since favorited queries can now be filter queries or bulk updates (filter + update).

You can download the latest version of the MongoDB Compass DEV version with the following links:

STAGING

https://preview-mongodbianfmongodb.gatsbyjs.io/compass/DOCSP-34569/documents/

https://preview-mongodbianfmongodb.gatsbyjs.io/compass/DOCSP-34569/documents/modify-multiple/

https://preview-mongodbianfmongodb.gatsbyjs.io/compass/DOCSP-34569/query/queries/#std-label-saved-favorite-query-view

JIRA

https://jira.mongodb.org/browse/DOCSP-34569

BUILD LOG

https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=6570a72f7a5cb5fef575c30b

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Is this free of spelling errors?
Is this free of grammatical errors?
Is this free of staging / rendering issues?
Are all the links working?

External Review Requirements

What's expected of an external reviewer?

ianf-mongodb · 2023-12-01T16:16:18Z

Hi @kmruiz , @lerouxb the docs for Compass bulk updates are ready for tech review.

Pinging @jaoppenheim as optional / for visibility.

ianf-mongodb · 2023-12-05T12:47:19Z

@lerouxb @kmruiz Just bringing this to the top of your inbox.

source/documents/modify-multiple.txt

kmruiz · 2023-12-05T14:16:41Z

Hey, just checked and everything seems fine.

I would still suggest to use Update Query, as it stores the whole query (filter + update specification) which is technically a query. I know it might feel weird, but this would be the correct naming (unless we want to use update command, but that wouldn't be consistent with the UI).

However I leave @lerouxb and you folks to decide the better naming.

lerouxb · 2023-12-06T12:49:38Z

I agree update query is better because these become recent/favourite queries once run or saved.

lerouxb · 2023-12-06T12:52:43Z

source/documents.txt

-:ref:`delete <compass-delete-documents>` documents in your selected
-collection or view.
+:ref:`modify <compass-modify-documents>`, 
+:ref:`modify multiple <compass-bulk-update>`,


Hmm. The documentation refers to this as "modify multiple" throughout and we refer to it as update or bulk update. And for single ones we refer to it as "edit". I don't know if this matters.

I think this could be a situation where we are describing the functionality vs the feature name. Similar to how we labeled the Generative AI stuff as "Query with Natural Language" to better articulate the use case. Do you have any preference here @jaoppenheim? Does it need to be labeled bulk updates or is "modify multiple" sufficient?

I think modify is fine since that is the language that we already have in our docs today

Co-authored-by: Kevin Mas Ruiz <[email protected]>

ianf-mongodb · 2023-12-06T13:45:00Z

Thanks for the feedback @kmruiz I have updated to "update query" based on both you and Le Rouxs feedback.

jaoppenheim · 2023-12-06T15:27:21Z

source/documents.txt

-:ref:`delete <compass-delete-documents>` documents in your selected
-collection or view.
+:ref:`modify <compass-modify-documents>`, 
+:ref:`modify multiple <compass-bulk-update>`,


I think modify is fine since that is the language that we already have in our docs today

jaoppenheim · 2023-12-06T15:34:11Z

source/documents/modify-multiple.txt

+   :style:  normal
+
+   .. step:: Open the bulk update modal


Even though this is listed in the table, I think it would make sense for the first step to be to filter the documents you want to update in the query bar. Chronologically, this has to happen first. We can say something like "if you would like to update all of the documents in the collection, skip this step and proceed to step 2."

jaoppenheim · 2023-12-06T15:35:26Z

source/documents/modify-multiple.txt

+           - Any filter criteria specified on the 
+             :guilabel:`Query Bar` applies to the 
+             :guilabel:`Update Documents` modal.


can we add something along the lines of "You must return to the query bar to edit this field" or "you must exit the update modal to edit this field"

jaoppenheim · 2023-12-06T15:37:19Z

source/documents/modify-multiple.txt

+      The number of documents affected by the update displays in 
+      the top of the :guilabel:`Update Documents` modal in 
+      parentheses.


you can remove the "in parentheses" part. we changed this from the original designs to read more like a sentence in the UI.

jaoppenheim · 2023-12-06T15:39:00Z

source/documents/modify-multiple.txt

+
+         The documents under the :guilabel:`Preview` header show how the 
+         :guilabel:`Update` syntax affects documents in your collection.


"syntax" makes sense above, because you are talking about the actual syntax that a user has to write. here (and below) it feels a little weird. We could say "Update command" or simply just the bolded "Update" (I may prefer the latter)

jaoppenheim · 2023-12-06T15:44:20Z

source/documents/modify-multiple.txt

+      within the filter criteria in the :guilabel:`Filter` expression.
+
+Example


At some point in this section, would it make sense to show an example before and after document? I'll leave it up to you to decide but it felt natural to me as a reader since you mentioned the preview section

jaoppenheim · 2023-12-06T15:54:52Z

source/includes/fact-viewing-favorite-queries.rst

@@ -12,4 +12,22 @@

   .. step:: Click the :guilabel:`Favorites` button in the past queries pane.

-      Select favorite queries.
+      Select your favorited syntax.


again I don't think syntax is the right word here. You could say "operation" but open to other ideas as long as it's consistent throughout

jaoppenheim · 2023-12-06T15:56:42Z

source/includes/fact-viewing-favorite-queries.rst

-      Select favorite queries.
+      Select your favorited syntax.
+
+      - If your favorited syntax is a query, only a :guilabel:`Filter` 


note to change the word syntax here

jaoppenheim · 2023-12-06T15:56:54Z

source/includes/fact-viewing-favorite-queries.rst

+        along with copy :icon-lg:`Copy` and delete :icon-lg:`Trash` 
+        icons.
+
+      - If your favorited syntax is a bulk update statement, a 


note to change the word syntax here as well

jaoppenheim · 2023-12-06T15:59:10Z

source/includes/fact-viewing-favorite-queries.rst

+
+        .. note::
+
+            Clicking the open modal icon, opens the bulk update statement 


While this is true, I also think it it's worth noting above that clicking on a regular query will populate the filter bar and simply clicking on the update will open the model (you don't have to click an icon)

ianf-mongodb · 2023-12-06T16:56:06Z

Thanks for the review @jaoppenheim, this is ready for another look.

jaoppenheim

Thanks for making those changes! LGTM

docs-builder-bot · 2023-12-06T19:15:54Z

✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/compass/bulk-operations/

🪵 Logs

job log: d30474b42954ecbc9411db37572d465ebcac8966

* DOCSP-34356 Staging Bulk Operations Content (#577) * DOCSP-34356 Staging Bulk Operations Content * DOCSP-34569 Bulk Update Task Page (#580) * DOCSP-34569 Bulk Update Task Page * DOCSP-34570 Bulk Deletes (#585) * DOCSP-34570 Bulk Deletes * DOCSP-35111 Compass 1.42.0 Release Notes * * * * * * * * * * * * * * * * * Apply suggestions from code review Co-authored-by: Alison Huh <[email protected]> --------- Co-authored-by: Alison Huh <[email protected]>

ianf-mongodb added 30 commits November 20, 2023 10:14

DOCSP-34569 Bulk Update Task Page

be8fdb5

*

0a6b621

*

11d662f

*

954e75b

*

6fb0c0b

*

42c3187

*

0901486

*

985017b

*

62977fd

*

21272fe

*

845d8c2

*

c4393df

*

a1a3a26

*

c561439

*

31d516d

*

1bfe275

*

1232f31

*

068ab61

*

c12bda0

*

971d5e8

*

8cad6a2

*

41a0083

*

538a0a5

*

ef870dd

*

e1b9ba5

*

ecec615

*

10e4155

*

c641443

*

f452a60

*

2fd9fdf

ianf-mongodb requested review from lerouxb and kmruiz December 1, 2023 16:13

kmruiz reviewed Dec 5, 2023

View reviewed changes

source/documents/modify-multiple.txt Outdated Show resolved Hide resolved

kmruiz reviewed Dec 5, 2023

View reviewed changes

source/documents/modify-multiple.txt Outdated Show resolved Hide resolved

kmruiz reviewed Dec 5, 2023

View reviewed changes

source/documents/modify-multiple.txt Outdated Show resolved Hide resolved

kmruiz reviewed Dec 5, 2023

View reviewed changes

source/documents/modify-multiple.txt Outdated Show resolved Hide resolved

lerouxb reviewed Dec 6, 2023

View reviewed changes

lerouxb approved these changes Dec 6, 2023

View reviewed changes

Apply suggestions from code review

10025ce

Co-authored-by: Kevin Mas Ruiz <[email protected]>

ianf-mongodb added 2 commits December 6, 2023 08:54

*

561e7cf

*

0adb56a

jaoppenheim suggested changes Dec 6, 2023

View reviewed changes

ianf-mongodb added 7 commits December 6, 2023 11:28

*

9eec497

*

6510faa

*

28d40ae

*

9f22150

*

c1db844

*

3753387

*

a50ea59

ianf-mongodb requested a review from jaoppenheim December 6, 2023 16:55

jaoppenheim approved these changes Dec 6, 2023

View reviewed changes

ianf-mongodb merged commit d30474b into mongodb:bulk-operations Dec 6, 2023
1 check failed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-34569 Bulk Update Task Page #580

DOCSP-34569 Bulk Update Task Page #580

ianf-mongodb commented Nov 20, 2023 •

edited

Loading

ianf-mongodb commented Dec 1, 2023

ianf-mongodb commented Dec 5, 2023

kmruiz commented Dec 5, 2023

lerouxb commented Dec 6, 2023

lerouxb Dec 6, 2023

ianf-mongodb Dec 6, 2023

jaoppenheim Dec 6, 2023

ianf-mongodb commented Dec 6, 2023

jaoppenheim Dec 6, 2023

jaoppenheim Dec 6, 2023

jaoppenheim Dec 6, 2023

jaoppenheim Dec 6, 2023

jaoppenheim Dec 6, 2023

jaoppenheim Dec 6, 2023

jaoppenheim Dec 6, 2023

jaoppenheim Dec 6, 2023

jaoppenheim Dec 6, 2023

jaoppenheim Dec 6, 2023

ianf-mongodb commented Dec 6, 2023

jaoppenheim left a comment

docs-builder-bot commented Dec 6, 2023


		The documents under the :guilabel:`Preview` header show how the
		:guilabel:`Update` syntax affects documents in your collection.

		within the filter criteria in the :guilabel:`Filter` expression.

		Example


		.. note::

		Clicking the open modal icon, opens the bulk update statement

DOCSP-34569 Bulk Update Task Page #580

DOCSP-34569 Bulk Update Task Page #580

Conversation

ianf-mongodb commented Nov 20, 2023 • edited Loading

DESCRIPTION

STAGING

JIRA

BUILD LOG

Self-Review Checklist

External Review Requirements

ianf-mongodb commented Dec 1, 2023

ianf-mongodb commented Dec 5, 2023

kmruiz commented Dec 5, 2023

lerouxb commented Dec 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ianf-mongodb commented Dec 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ianf-mongodb commented Dec 6, 2023

jaoppenheim left a comment

Choose a reason for hiding this comment

docs-builder-bot commented Dec 6, 2023

🪵 Logs

ianf-mongodb commented Nov 20, 2023 •

edited

Loading