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-47211-default-sort-order-setting #724

Merged
merged 9 commits into from
Mar 3, 2025

Conversation

ltran-mdb2
Copy link
Collaborator

@ltran-mdb2 ltran-mdb2 commented Feb 27, 2025

DESCRIPTION

Adds new page on default sort order setting

STAGING

https://deploy-preview-724--docs-compass.netlify.app/settings/set-default-sort/#std-label-compass-sort-query-bar
https://deploy-preview-724--docs-compass.netlify.app/settings/settings-reference/#settings
https://deploy-preview-724--docs-compass.netlify.app/query/sort/

JIRA

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

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?

Copy link

netlify bot commented Feb 27, 2025

Deploy Preview for docs-compass ready!

Name Link
🔨 Latest commit 94f237e
🔍 Latest deploy log https://app.netlify.com/sites/docs-compass/deploys/67c6283e0448690008124c06
😎 Deploy Preview https://deploy-preview-724--docs-compass.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@kennethdyer kennethdyer left a comment

Choose a reason for hiding this comment

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

Thanks @ltran-mdb2, I left a few non-blocking suggestions for your consideration. LGTM!

Set Default Sort Order
======================

.. default-domain:: mongodb
Copy link
Collaborator

Choose a reason for hiding this comment

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

I believe this directive is no longer functional. It was being removed in some tickets earlier this week.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

* - Sort Key
- Description

* - $natural: 1
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should these be literals?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

They're shown in normal text on the Compass UI (shown in screenshot) but I will check with tech review
Screenshot 2025-03-03 at 12 33 57 PM

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@djechlin-mongodb what do you think here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Discussed with @djechlin-mongodb and we decided to leave these as non literals to match the Compass UI


.. list-table::
:header-rows: 1
:widths: 20 80
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggestion: We don't use it widely, but with these sort of lexical reference tables the :stub-columns: 1 option sometimes helps with formatting for clarity.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

Copy link

@djechlin-mongodb djechlin-mongodb left a comment

Choose a reason for hiding this comment

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

I think it's good. Was wondering if you'd want to cover that these "defaults" aren't saved as part of the query when queries are saved, and furthermore that they're applied to already saved queries. I'm not sure if that level of detail is necessary.

@ltran-mdb2
Copy link
Collaborator Author

I think it's good. Was wondering if you'd want to cover that these "defaults" aren't saved as part of the query when queries are saved, and furthermore that they're applied to already saved queries. I'm not sure if that level of detail is necessary.

I added a line about how these defaults are not saved as part of saved queries!

@ltran-mdb2 ltran-mdb2 merged commit bf57cb4 into mongodb:master Mar 3, 2025
4 of 5 checks passed
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