Skip to content

DOCSP-38547 Standardize Quick Start Name #116

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

Merged

Conversation

jordan-smith721
Copy link
Collaborator

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-38547
Staging - https://preview-mongodbjordansmith721.gatsbyjs.io/rust/DOCSP-38547-quickstart-name/

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Did you run a spell-check?
  • Did you run a grammar-check?
  • Are all the links working?
  • Are the facets and meta keywords accurate?

Copy link
Contributor

@ccho-mongodb ccho-mongodb left a comment

Choose a reason for hiding this comment

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

LGTM! Added a suggestion, but maybe @sarahemlin can clarify the ticket request.

Quick Start
===========
================
Rust Quick Start
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion:

While the example in the ticket description uses "Go Quick Start" as an example, it also mentions using the product name. In this case, I think "{+driver-long+} Quick Start" might be the most helpful title to understand the content immediately from the results of a Google search.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@sarahemlin could you clarify what you're looking for here? For more context "{+driver-long+} Quick Start" would translate to "MongoDB Rust Driver Quick Start" (and similar for the other drivers)

Copy link
Collaborator

Choose a reason for hiding this comment

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

Hey @jordan-smith721! That works for me. The domain kind of takes care of linking this driver to MongoDB, so I would usually put the company name in the meta description. However, it isn't that big of a deal if you all prefer to have the full name in the title. So long as the TOC remains short, I'm okay.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks! I discussed it with Chris a bit more over Slack and we decided to go with "Rust Driver Quick Start" as a good middle ground

@jordan-smith721 jordan-smith721 merged commit 330f2d7 into mongodb:master Apr 22, 2024
jordan-smith721 added a commit that referenced this pull request Apr 22, 2024
jordan-smith721 added a commit that referenced this pull request Apr 22, 2024
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