[DOCS-13376] Tweaks to validate documentation Created: 29/Jan/20 Updated: 30/Oct/23 Resolved: 02/Sep/21 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | manual, Server |
| Affects Version/s: | None |
| Fix Version/s: | Server_Docs_20231030 |
| Type: | Improvement | Priority: | Major - P3 |
| Reporter: | Eric Sedor | Assignee: | Jeffrey Allen |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | docs-administration | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Participants: | |
| Days since reply: | 2 years, 22 weeks, 6 days ago |
| Epic Link: | DOCSP-11702 |
| Story Points: | 3 |
| Description |
DescriptionCan we please add a warning box to both of the following doc locations.
The warning box should read something like "Warning: Because of the performance impact of validation, avoid running validate on a replica set primary unless absolutely necessary." In addition, it would be nice for the validate shell method documentation (https://docs.mongodb.com/manual/reference/method/db.collection.validate/) to explicitly say it is a wrapper for the validate command, and link to https://docs.mongodb.com/manual/reference/command/validate/index.html. Cribbing from other places in the docs where we do this: "The db.collection.validate() method provides a wrapper around the validate command." (cc kelsey.schubert) Scope of changesImpact to Other DocsMVP (Work and Date)Resources (Scope or Design Docs, Invision, etc.) |
| Comments |
| Comment by Githook User [ 02/Sep/21 ] |
|
Author: {'name': 'Jeff Allen', 'email': 'jeffrey.allen@10gen.com', 'username': 'jeff-allen-mongo'}Message: ( |
| Comment by Githook User [ 02/Sep/21 ] |
|
Author: {'name': 'Jeff Allen', 'email': 'jeffrey.allen@10gen.com', 'username': 'jeff-allen-mongo'}Message: ( |
| Comment by Githook User [ 02/Sep/21 ] |
|
Author: {'name': 'Jeff Allen', 'email': 'jeffrey.allen@10gen.com', 'username': 'jeff-allen-mongo'}Message: ( |
| Comment by Githook User [ 02/Sep/21 ] |
|
Author: {'name': 'Jeff Allen', 'email': 'jeffrey.allen@10gen.com', 'username': 'jeff-allen-mongo'}Message: ( |
| Comment by Jeffrey Allen [ 02/Sep/21 ] |
|
Going to merge this change given LGTM from eric.sedor and louis.williams. Thank you both for your reviews! |
| Comment by Eric Sedor [ 02/Sep/21 ] |
|
Adding louis.williams for an LGTM |
| Comment by Eric Sedor [ 02/Sep/21 ] |
|
I ended up proposing new language during review over a few things:
|
| Comment by Eric Sedor [ 02/Sep/21 ] |
|
This seems like a quick win and we've been broadcasting critical advisories involving validate a lot recently. Can we please make these improvements and follow up when geert.bosch is able to address Kelsey's question? If it's inaccurate, the inaccuracy is currently live. |
| Comment by Kelsey Schubert [ 29/Jan/20 ] |
|
I think the following existing text
would also benefit from being more red. geert.bosch, could you confirm that the second sentence about validate blocking all other operations on the secondary until it finishes is still true? |