<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 08:07:37 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>MongoDB Jira</title>
    <link>https://jira.mongodb.org</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>9.7.1</version>
        <build-number>970001</build-number>
        <build-date>13-04-2023</build-date>
    </build-info>


<item>
            <title>[DOCS-13376] Tweaks to validate documentation</title>
                <link>https://jira.mongodb.org/browse/DOCS-13376</link>
                <project id="10380" key="DOCS">Documentation</project>
                    <description>&lt;h2&gt;&lt;a name=&quot;Description&quot;&gt;&lt;/a&gt;Description&lt;/h2&gt;
&lt;p&gt;Can we please add a warning box to both of the following doc locations.&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;&lt;a href=&quot;https://docs.mongodb.com/manual/reference/command/validate/index.html&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://docs.mongodb.com/manual/reference/command/validate/index.html&lt;/a&gt;&lt;/li&gt;
	&lt;li&gt;&lt;a href=&quot;https://docs.mongodb.com/manual/reference/method/db.collection.validate/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://docs.mongodb.com/manual/reference/method/db.collection.validate/&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;The warning box should read something like &quot;Warning: Because of the performance impact of validation, avoid running validate on a replica set primary unless absolutely necessary.&quot;&lt;/p&gt;

&lt;p&gt;In addition, it would be nice for the validate shell method documentation (&lt;a href=&quot;https://docs.mongodb.com/manual/reference/method/db.collection.validate/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://docs.mongodb.com/manual/reference/method/db.collection.validate/&lt;/a&gt;) to explicitly say it is a wrapper for the validate command, and link to &lt;a href=&quot;https://docs.mongodb.com/manual/reference/command/validate/index.html&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://docs.mongodb.com/manual/reference/command/validate/index.html&lt;/a&gt;.&lt;/p&gt;

&lt;p&gt;Cribbing from other places in the docs where we do this: &quot;The db.collection.validate() method provides a wrapper around the &lt;a href=&quot;https://docs.mongodb.com/manual/reference/command/validate/index.html&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;validate&lt;/a&gt; command.&quot;&lt;/p&gt;

&lt;p&gt;(cc &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=kelsey.schubert&quot; class=&quot;user-hover&quot; rel=&quot;kelsey.schubert&quot;&gt;kelsey.schubert&lt;/a&gt;)&lt;/p&gt;

&lt;h2&gt;&lt;a name=&quot;Scopeofchanges&quot;&gt;&lt;/a&gt;Scope of changes&lt;/h2&gt;

&lt;h2&gt;&lt;a name=&quot;ImpacttoOtherDocs&quot;&gt;&lt;/a&gt;Impact to Other Docs&lt;/h2&gt;

&lt;h2&gt;&lt;a name=&quot;MVP%28WorkandDate%29&quot;&gt;&lt;/a&gt;MVP (Work and Date)&lt;/h2&gt;

&lt;h2&gt;&lt;a name=&quot;Resources%28ScopeorDesignDocs%2CInvision%2Cetc.%29&quot;&gt;&lt;/a&gt;Resources (Scope or Design Docs, Invision, etc.)&lt;/h2&gt;
</description>
                <environment></environment>
        <key id="1120743">DOCS-13376</key>
            <summary>Tweaks to validate documentation</summary>
                <type id="4" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14710&amp;avatarType=issuetype">Improvement</type>
                                            <priority id="3" iconUrl="https://jira.mongodb.org/images/icons/priorities/major.svg">Major - P3</priority>
                        <status id="6" iconUrl="https://jira.mongodb.org/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="13201">Fixed</resolution>
                                        <assignee username="jeffrey.allen@mongodb.com">Jeffrey Allen</assignee>
                                    <reporter username="eric.sedor@mongodb.com">Eric Sedor</reporter>
                        <labels>
                            <label>docs-administration</label>
                    </labels>
                <created>Wed, 29 Jan 2020 21:11:33 +0000</created>
                <updated>Mon, 30 Oct 2023 20:28:30 +0000</updated>
                            <resolved>Thu, 2 Sep 2021 21:41:05 +0000</resolved>
                                                    <fixVersion>Server_Docs_20231030</fixVersion>
                                    <component>manual</component>
                    <component>Server</component>
                        <due></due>
                            <votes>0</votes>
                                    <watches>3</watches>
                                                                                                                <comments>
                            <comment id="4038011" author="xgen-internal-githook" created="Thu, 2 Sep 2021 21:43:43 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Jeff Allen&apos;, &apos;email&apos;: &apos;jeffrey.allen@10gen.com&apos;, &apos;username&apos;: &apos;jeff-allen-mongo&apos;}
&lt;p&gt;Message: (&lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-13376&quot; title=&quot;Tweaks to validate documentation&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-13376&quot;&gt;&lt;del&gt;DOCS-13376&lt;/del&gt;&lt;/a&gt;): Add performance warnings for validation&lt;br/&gt;
Branch: v4.2&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/docs/commit/5a7a05672b0940d1f4f676437e3f45b4bb2efabd&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs/commit/5a7a05672b0940d1f4f676437e3f45b4bb2efabd&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="4038004" author="xgen-internal-githook" created="Thu, 2 Sep 2021 21:37:05 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Jeff Allen&apos;, &apos;email&apos;: &apos;jeffrey.allen@10gen.com&apos;, &apos;username&apos;: &apos;jeff-allen-mongo&apos;}
&lt;p&gt;Message: (&lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-13376&quot; title=&quot;Tweaks to validate documentation&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-13376&quot;&gt;&lt;del&gt;DOCS-13376&lt;/del&gt;&lt;/a&gt;): Add performance warnings for validation&lt;br/&gt;
Branch: v4.4&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/docs/commit/1d023ad0467d79e164ff81cc58192104775a8486&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs/commit/1d023ad0467d79e164ff81cc58192104775a8486&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="4038002" author="xgen-internal-githook" created="Thu, 2 Sep 2021 21:36:47 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Jeff Allen&apos;, &apos;email&apos;: &apos;jeffrey.allen@10gen.com&apos;, &apos;username&apos;: &apos;jeff-allen-mongo&apos;}
&lt;p&gt;Message: (&lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-13376&quot; title=&quot;Tweaks to validate documentation&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-13376&quot;&gt;&lt;del&gt;DOCS-13376&lt;/del&gt;&lt;/a&gt;): Add performance warnings for validation&lt;br/&gt;
Branch: v5.0&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/docs/commit/aff1d3faa679c5f56ca765241a5cb6ab50af417a&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs/commit/aff1d3faa679c5f56ca765241a5cb6ab50af417a&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="4038001" author="xgen-internal-githook" created="Thu, 2 Sep 2021 21:36:24 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Jeff Allen&apos;, &apos;email&apos;: &apos;jeffrey.allen@10gen.com&apos;, &apos;username&apos;: &apos;jeff-allen-mongo&apos;}
&lt;p&gt;Message: (&lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-13376&quot; title=&quot;Tweaks to validate documentation&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-13376&quot;&gt;&lt;del&gt;DOCS-13376&lt;/del&gt;&lt;/a&gt;): Add performance warnings for validation&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/docs/commit/22e1172b80a8f6c30a25af7548f3bb3e5a37a6a0&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs/commit/22e1172b80a8f6c30a25af7548f3bb3e5a37a6a0&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="4037995" author="jeffrey.allen" created="Thu, 2 Sep 2021 21:34:36 +0000"  >&lt;p&gt;Going to merge this change given LGTM from &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=eric.sedor&quot; class=&quot;user-hover&quot; rel=&quot;eric.sedor&quot;&gt;eric.sedor&lt;/a&gt; and &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=louis.williams&quot; class=&quot;user-hover&quot; rel=&quot;louis.williams&quot;&gt;louis.williams&lt;/a&gt;. Thank you both for your reviews!&lt;/p&gt;</comment>
                            <comment id="4037852" author="eric.sedor" created="Thu, 2 Sep 2021 20:39:43 +0000"  >&lt;p&gt;Adding &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=louis.williams&quot; class=&quot;user-hover&quot; rel=&quot;louis.williams&quot;&gt;louis.williams&lt;/a&gt; for an LGTM&lt;/p&gt;</comment>
                            <comment id="4037841" author="eric.sedor" created="Thu, 2 Sep 2021 20:35:14 +0000"  >&lt;p&gt;I ended up proposing new language during review over a few things:&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Given the warning box as context, the specific details about validation&apos;s behavior seem more accessible in staging&lt;/li&gt;
	&lt;li&gt;For small or uncommonly accessed collections &quot;absolutely necessary&quot; is strong.&lt;/li&gt;
	&lt;li&gt;I felt able to work in a reference to replSetStepDown, suggesting how users could/should validate a replica set&lt;/li&gt;
&lt;/ul&gt;
</comment>
                            <comment id="4037143" author="eric.sedor" created="Thu, 2 Sep 2021 17:15:03 +0000"  >&lt;p&gt;This seems like a quick win and we&apos;ve been broadcasting critical advisories involving validate a lot recently.&lt;/p&gt;

&lt;p&gt;Can we please make these improvements and follow up when &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=geert.bosch&quot; class=&quot;user-hover&quot; rel=&quot;geert.bosch&quot;&gt;geert.bosch&lt;/a&gt; is able to address Kelsey&apos;s question? If it&apos;s inaccurate, the inaccuracy is currently live.&lt;/p&gt;</comment>
                            <comment id="2771558" author="thomas.schubert" created="Wed, 29 Jan 2020 21:47:15 +0000"  >&lt;p&gt;I think the following existing text&lt;/p&gt;

&lt;blockquote&gt;
&lt;p&gt;The validate command obtains an exclusive lock W on the collection. This will block all reads and writes on the collection until the operation finishes. When run on a secondary, the validate operation can block all other operations on that secondary until it finishes.&lt;/p&gt;&lt;/blockquote&gt;

&lt;p&gt;would also benefit from being more red. &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=geert.bosch&quot; class=&quot;user-hover&quot; rel=&quot;geert.bosch&quot;&gt;geert.bosch&lt;/a&gt;, could you confirm that the second sentence about validate blocking all other operations on the secondary until it finishes is still true?&lt;/p&gt;</comment>
                    </comments>
                    <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                <customfield id="customfield_10050" key="com.atlassian.jira.toolkit:comments">
                        <customfieldname># Replies</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>9.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10055" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>Date of 1st Reply</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Wed, 29 Jan 2020 21:47:15 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10052" key="com.atlassian.jira.toolkit:dayslastcommented">
                        <customfieldname>Days since reply</customfieldname>
                        <customfieldvalues>
                                        2 years, 22 weeks, 6 days ago
    
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_18254" key="com.onresolve.jira.groovy.groovyrunner:scripted-field">
                        <customfieldname>Dependencies</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue><![CDATA[]]></customfieldvalue>


                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_15850" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10857" key="com.pyxis.greenhopper.jira:gh-epic-link">
                        <customfieldname>Epic Link</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>DOCSP-11702</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_14873" key="com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker">
                        <customfieldname>External Reviewer</customfieldname>
                        <customfieldvalues>
                                    <customfieldvalue><![CDATA[eric.sedor@mongodb.com]]></customfieldvalue>
        <customfieldvalue><![CDATA[louis.williams@mongodb.com]]></customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                <customfield id="customfield_10057" key="com.atlassian.jira.toolkit:lastusercommented">
                        <customfieldname>Last comment by Customer</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>true</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10056" key="com.atlassian.jira.toolkit:lastupdaterorcommenter">
                        <customfieldname>Last commenter</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>emet.ozar@mongodb.com</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_11151" key="com.atlassian.jira.toolkit:LastCommentDate">
                        <customfieldname>Last public comment date</customfieldname>
                        <customfieldvalues>
                            2 years, 22 weeks, 6 days ago
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10051" key="com.atlassian.jira.toolkit:participants">
                        <customfieldname>Participants</customfieldname>
                        <customfieldvalues>
                                        <customfieldvalue>eric.sedor@mongodb.com</customfieldvalue>
            <customfieldvalue>xgen-internal-githook</customfieldvalue>
            <customfieldvalue>jeffrey.allen@mongodb.com</customfieldvalue>
            <customfieldvalue>kelsey.schubert@mongodb.com</customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                        <customfield id="customfield_14254" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Product Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|hwm6f3:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hwa613:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10558" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>9223372036854775807</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                    <customfield id="customfield_10557" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue id="5439">ServerDocs2021: Aug31 - Sep07</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                        <customfield id="customfield_10555" key="com.atlassian.jira.plugin.system.customfieldtypes:float">
                        <customfieldname>Story Points</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>3.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_10053" key="com.atlassian.jira.ext.charting:timeinstatus">
                        <customfieldname>Time In Status</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_14350" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>serverRank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|hwlsof:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                </customfields>
    </item>
</channel>
</rss>