Skip to content
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.

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

DOCSP-33172 added meta description for top 250 pages in docs-compass #581

Merged
merged 2 commits into from
Dec 8, 2023

Conversation

sarahemlin
Copy link
Collaborator

DESCRIPTION

Hey @sarah-olson-mongodb! I'm adding descriptions to the top 250 pages that don't have them, and here are the Compass pages that needed them. I mostly just copied from the page text, but please check for coherence & conventions and edit as you see fit.

Thanks!
Sarah

STAGING

https://preview-mongodbsarahemlin.gatsbyjs.io/compass/DOCSP-33172/

JIRA

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

BUILD LOG

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

Copy link
Collaborator

@sarah-olson-mongodb sarah-olson-mongodb left a comment

Choose a reason for hiding this comment

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

Thanks @sarahemlin. Couple minor suggestions for consideration. Over all LGTM!

One thing I noticed is that the structure of the description varies in a few ways.

  • How to ...
    Ex: How to add and view favorite saved queries and aggregations.

  • Noun ... verb
    Ex: MongoDB Compass is a powerful GUI for querying, aggregating, and analyzing your MongoDB data in a visual environment run on macOS, Windows, and Linux.

  • Verb ... noun
    Ex: Query documents in your Atlas, Enterprise, or Community database deployments.

It might be useful to develop some guidance on these descriptions so the team ca. take up this work, going forward.

source/collections.txt Show resolved Hide resolved
source/index.txt Outdated Show resolved Hide resolved
Co-authored-by: Sarah Olson <98367156+sarah-olson-mongodb@users.noreply.github.com>
@sarahemlin
Copy link
Collaborator Author

@sarah-olson-mongodb, regarding standardization, I don't think Google cares if we have a strict format. The words we choose matter more because they give Google more information about page intent for SEO. I don't think we should use 'how-to' on a reference page, but otherwise we just need something there. I'll add this for the updates I need to make to the style guide about SEO and we can discuss with the leads then. Sound good?

@sarah-olson-mongodb sarah-olson-mongodb merged commit be893ca into mongodb:master Dec 8, 2023
1 check passed
@docs-builder-bot
Copy link

@sarahemlin sarahemlin deleted the DOCSP-33172 branch December 8, 2023 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants