DOCSP-24433: SEO meta descriptions #389
Conversation
| @@ -2,7 +2,8 @@ | |||
| Delete Operations | |||
| ================= | |||
|
|
|||
| .. default-domain:: mongodb | |||
| .. meta:: | |||
| :description: See examples of deleting data from MongoDB by using the {+driver-long+}. | |||
There was a problem hiding this comment.
Comment; the phrase "deleting data from" sounds awkward. could it still be "deleting data IN.."?
There was a problem hiding this comment.
Hm, I think I've always heard the preposition "from" associated with "delete".
E.g. "Delete from your computer" vs "Delete in your computer"
Have you heard the latter before?
There was a problem hiding this comment.
The way i was thinking about it was that we are working "in" MongoDB and any operations are executed from that point of view. But I see your point too!
| @@ -2,7 +2,8 @@ | |||
| Find Operations | |||
| =============== | |||
|
|
|||
| .. default-domain:: mongodb | |||
| .. meta:: | |||
| :description: See examples of querying and retrieving data from MongoDB by using the {+driver-long+}. | |||
There was a problem hiding this comment.
C: since "querying" and "retrieving data from" aren't exactly parallel, could we just remove one of them?
There was a problem hiding this comment.
I think they are two separate actions, so maybe "querying data and retrieving data" would be appropriate.
Querying is the action of formulating instructions and sending the command to performing matching whereas retrieving is accessing the results, perhaps from a cursor.
| @@ -2,7 +2,8 @@ | |||
| Insert Operations | |||
| ================= | |||
|
|
|||
| .. default-domain:: mongodb | |||
| .. meta:: | |||
| :description: See examples of inserting data into MongoDB by using the {+driver-long+}. | |||
There was a problem hiding this comment.
Suggestion: for the usage examples, does this sound a little more natural?
| :description: See examples of inserting data into MongoDB by using the {+driver-long+}. | |
| :description: See how to insert data into MongoDB by using the {+driver-long+}. |
There was a problem hiding this comment.
By natural, did you mean avoiding using "examples" when the title of the page might include "examples"?
I don't have a strong preference for either your suggestion or the original text.
There was a problem hiding this comment.
I think including the word example is unnecessary-- including the word "how" might make it easier for users to pick up the point of these pages
There was a problem hiding this comment.
Makes sense. I think maybe I'll update this and all similar instances to "Learn how" since I think that seems more frequently used in our style guide examples.
There was a problem hiding this comment.
On second thought, the title of the page and how it would show up in search results is "Insert Operations", not "Usage Examples", so I think "examples" is important to mention. I will try rephrasing it a bit to avoid the gerund.
| @@ -2,7 +2,8 @@ | |||
| Write Operations | |||
| ================ | |||
|
|
|||
| .. default-domain:: mongodb | |||
| .. meta:: | |||
| :description: Learn the concepts related to storing data to MongoDB by using the {+driver-long+}. | |||
There was a problem hiding this comment.
| :description: Learn the concepts related to storing data to MongoDB by using the {+driver-long+}. | |
| :description: Learn the concepts related to writing data to MongoDB by using the {+driver-long+}. |
| @@ -2,7 +2,8 @@ | |||
| Read Operations | |||
| =============== | |||
|
|
|||
| .. default-domain:: mongodb | |||
| .. meta:: | |||
| :description: Learn about the commands for running MongoDB read operations by using the {+driver-long+}. | |||
There was a problem hiding this comment.
S: There are some inconsistencies about where MongoDB goes in the phrase "___ operation" across these descriptions. Maybe moving MongoDB out of the phrase will make it easier for users to understand that you are running an operation by using the driver to do something in/from/to MongoDB
| :description: Learn about the commands for running MongoDB read operations by using the {+driver-long+}. | |
| :description: Learn about the commands for running read operations on MongoDB by using the {+driver-long+}. |
* DOCSP-24433: SEO meta descriptions (cherry picked from commit f9a818c)
* DOCSP-24433: SEO meta descriptions (cherry picked from commit f9a818c)
* DOCSP-24433: SEO meta descriptions (cherry picked from commit f9a818c)
* DOCSP-24433: SEO meta descriptions (cherry picked from commit f9a818c)
* DOCSP-24433: SEO meta descriptions (cherry picked from commit f9a818c)
* DOCSP-24433: SEO meta descriptions (cherry picked from commit f9a818c)
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-24433
Staging - None (meta descriptions only)
Currently, meta descriptions are not rendering on staging nor the published site, so will wait to merge this.
Self-Review Checklist