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 27810 updating schema validation behavior #589

Merged
merged 7 commits into from
Jan 16, 2024

Conversation

ltran-mdb2
Copy link
Collaborator

@ltran-mdb2 ltran-mdb2 commented Jan 10, 2024

DESCRIPTION

schema validation no longer auto updates in Compass

STAGING

https://docs-mongodbcom-staging.corp.mongodb.com/compass/docsworker-xlarge/DOCSP-27810/validation/#validation-rules

JIRA

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

BUILD LOG

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

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
Collaborator

@ajhuh-mdb ajhuh-mdb left a comment

Choose a reason for hiding this comment

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

LGTM % a couple small fixes!

|compass-short| updates in real-time to display a document from your
collection that passes the validation and a document that fails.
expressions using :manual:`query operators </reference/operator/query>`.
When you hit the Update button, Compass updates to display a document
Copy link
Collaborator

Choose a reason for hiding this comment

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

[nit] For UI instructions, we want to be more explicit in what the users have to do — it might be confusing for international audiences to read about "hitting" a button.

Also for the update button, we want to add the :guilabel: directive!

Suggested change
When you hit the Update button, Compass updates to display a document
After you click the :guilabel:`Update` button, Compass updates to display a document

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! Thanks for your feedback!

@mdb-ashley mdb-ashley merged commit 6d7244d into mongodb:master Jan 16, 2024
1 check failed
@docs-builder-bot
Copy link

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.

5 participants