Skip to content

DOCSP-24433: SEO meta descriptions #389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Sep 22, 2023
Merged

DOCSP-24433: SEO meta descriptions #389

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ce14352
DOCSP-24433: SEO meta descriptions
May 4, 2023
52ed087
PR review fixes
May 5, 2023
8c59385
PRR fixes
May 5, 2023
bbcc906
fix for find operations usage examples
May 8, 2023
8daacf1
update wording for fundamentals
May 8, 2023
2136ab6
capitalization fixes
May 8, 2023
aa4f0b9
updated text for crud operations
May 9, 2023
5f748a9
add fundamentals landing page
May 10, 2023
c9b4134
Merge remote-tracking branch 'upstream/master' into DOCSP-24433-meta
Sep 21, 2023
88f4b30
address PRR comment
Sep 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions source/api-documentation.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
API Documentation
=================

.. meta::
:description: Read the API documentation for the {+driver-long+} and related packages.

- `BSON <{+api+}/apidocs/bson/index.html>`__ - classes for working with the
BSON data format.
- `BSON Record Codec <{+api+}/apidocs/bson-record-codec/index.html>`__ -
Expand Down
3 changes: 2 additions & 1 deletion source/fundamentals/crud/read-operations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
Read Operations
===============

.. default-domain:: mongodb
.. meta::
:description: Learn the concepts related to retrieving data from MongoDB by using the {+driver-long+}.

- :doc:`/fundamentals/crud/read-operations/retrieve`
- :doc:`/fundamentals/crud/read-operations/cursor`
Expand Down
3 changes: 2 additions & 1 deletion source/fundamentals/crud/write-operations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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+}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
: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+}.


- :doc:`/fundamentals/crud/write-operations/insert`
- :doc:`/fundamentals/crud/write-operations/delete`
Expand Down
3 changes: 2 additions & 1 deletion source/fundamentals/data-formats.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
Data Formats
============

.. default-domain:: mongodb
.. meta::
:description: Learn how to convert between MongoDB and Java data formats by using the {+driver-long+}.

- :doc:`/fundamentals/data-formats/document-data-format-bson`
- :doc:`/fundamentals/data-formats/document-data-format-extended-json`
Expand Down
5 changes: 3 additions & 2 deletions source/usage-examples/delete-operations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
Delete Operations
=================

.. default-domain:: mongodb
.. meta::
:description: See examples of deleting data from MongoDB by using the {+driver-long+}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment; the phrase "deleting data from" sounds awkward. could it still be "deleting data IN.."?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!


- :doc:`Delete a Document </usage-examples/deleteOne>`
- :doc:`Delete Multiple Documents </usage-examples/deleteMany>`
Expand All @@ -12,4 +13,4 @@ Delete Operations

/usage-examples/deleteOne
/usage-examples/deleteMany


3 changes: 2 additions & 1 deletion source/usage-examples/find-operations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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+}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

C: since "querying" and "retrieving data from" aren't exactly parallel, could we just remove one of them?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


- :doc:`Find a Document </usage-examples/findOne>`
- :doc:`Find Multiple Documents </usage-examples/find>`
Expand Down
3 changes: 2 additions & 1 deletion source/usage-examples/insert-operations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
Insert Operations
=================

.. default-domain:: mongodb
.. meta::
:description: See examples of inserting data into MongoDB by using the {+driver-long+}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: for the usage examples, does this sound a little more natural?

Suggested change
: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+}.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


- :doc:`Insert a Document </usage-examples/insertOne>`
- :doc:`Insert Multiple Documents </usage-examples/insertMany>`
Expand Down
3 changes: 2 additions & 1 deletion source/usage-examples/update-operations.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
Update & Replace Operations
===========================

.. default-domain:: mongodb
.. meta::
:description: See examples of updating and replacing data in MongoDB by using the {+driver-long+}.

- :doc:`Update a Document </usage-examples/updateOne>`
- :doc:`Update Multiple Documents </usage-examples/updateMany>`
Expand Down