<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 08:15:03 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-16285] [SERVER] Add internal use note to explain&apos;s slotBasedPlan field description</title>
                <link>https://jira.mongodb.org/browse/DOCS-16285</link>
                <project id="10380" key="DOCS">Documentation</project>
                    <description>&lt;p&gt;To the slotBasedPlan field description &lt;a href=&quot;https://www.mongodb.com/docs/manual/reference/explain-results/#mongodb-data-explain.queryPlanner.winningPlan.slotBasedPlan&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;here&lt;/a&gt; can we please add:&lt;/p&gt;

&lt;p&gt;&quot;This field is for internal use by MongoDB engineering during support engagements as needed.&quot;&lt;/p&gt;</description>
                <environment></environment>
        <key id="2405255">DOCS-16285</key>
            <summary>[SERVER] Add internal use note to explain&apos;s slotBasedPlan field description</summary>
                <type id="3" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14718&amp;avatarType=issuetype">Task</type>
                                            <priority id="4" iconUrl="https://jira.mongodb.org/images/icons/priorities/minor.svg">Minor - P4</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="9">Done</resolution>
                                        <assignee username="matt.maville@mongodb.com">Matthew Maville</assignee>
                                    <reporter username="eric.sedor@mongodb.com">Eric Sedor</reporter>
                        <labels>
                            <label>quick-win</label>
                            <label>request</label>
                    </labels>
                <created>Mon, 31 Jul 2023 16:02:17 +0000</created>
                <updated>Tue, 16 Jan 2024 15:38:26 +0000</updated>
                            <resolved>Mon, 8 Jan 2024 22:33:59 +0000</resolved>
                                                    <fixVersion>Server_Docs_[20240116]</fixVersion>
                                    <component>manual</component>
                    <component>Server</component>
                        <due></due>
                            <votes>0</votes>
                                    <watches>8</watches>
                                                                                                                <comments>
                            <comment id="5958851" author="JIRAUSER1275572" created="Mon, 18 Dec 2023 22:37:42 +0000"  >&lt;p&gt;Adding &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=eric.sedor%40mongodb.com&quot; class=&quot;user-hover&quot; rel=&quot;eric.sedor@mongodb.com&quot;&gt;eric.sedor@mongodb.com&lt;/a&gt; for external review of changes.&lt;/p&gt;</comment>
                            <comment id="5952058" author="JIRAUSER1275572" created="Thu, 14 Dec 2023 20:14:05 +0000"  >&lt;p&gt;Tagging &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=christopher.harris%40mongodb.com&quot; class=&quot;user-hover&quot; rel=&quot;christopher.harris@mongodb.com&quot;&gt;christopher.harris@mongodb.com&lt;/a&gt; for comment now that we having a staging preview. I think the clean up of the links is great and that the note we found is sufficient for the internal use notice. Just want to ensure we&apos;re fully on-board with not adding the internal only note to slotBasedPlan on the product side as requested in the original ticket.&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://preview-mongodbmmavillemdb.gatsbyjs.io/docs/DOCS-16285-slotBasedPlan-internal-only-note/reference/sbe/#check-query-explain-results&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://preview-mongodbmmavillemdb.gatsbyjs.io/docs/DOCS-16285-slotBasedPlan-internal-only-note/reference/sbe/#check-query-explain-results&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="5946057" author="jeffrey.allen" created="Tue, 12 Dec 2023 22:32:51 +0000"  >&lt;p&gt;&lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=matt.maville%40mongodb.com&quot; class=&quot;user-hover&quot; rel=&quot;matt.maville@mongodb.com&quot;&gt;matt.maville@mongodb.com&lt;/a&gt;, those are good findings and considerations. I think it&apos;s confusing that in the &lt;a href=&quot;https://www.mongodb.com/docs/v7.0/reference/sbe/#check-query-explain-results&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;Check Query Explain Results&lt;/a&gt; section we link to the same Explain Results page three times (each to a different anchor point).&lt;/p&gt;

&lt;p&gt;&#160;&lt;/p&gt;

&lt;p&gt;As part of this update, it might be helpful to reduce those links down to a single link. My initial idea is to remove the initial link to &quot;explain results&quot; (replace with plain text) and the &quot;explain.queryPlanner.winningPlan.slotBasedPlan&quot; link (replace with monospace text), and only retain the link to the &quot;Explain Output Structure&quot; that appears at the end of the section.&lt;/p&gt;

&lt;p&gt;&#160;&lt;/p&gt;

&lt;p&gt;I don&apos;t think we necessarily need to include the &quot;This field is for internal use by MongoDB engineering during support engagements as needed.&quot; blurb in the &quot;Check Query Explain Results&quot; section. IMO, only having that blurb appear where we define the field itself on the Explain Results page is sufficient.&lt;/p&gt;

&lt;p&gt;&#160;&lt;/p&gt;

&lt;p&gt;Just going to tag &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=christopher.harris%40mongodb.com&quot; class=&quot;user-hover&quot; rel=&quot;christopher.harris@mongodb.com&quot;&gt;christopher.harris@mongodb.com&lt;/a&gt; here in case he has opinions from the product side of things.&lt;/p&gt;</comment>
                            <comment id="5945980" author="JIRAUSER1275572" created="Tue, 12 Dec 2023 22:06:26 +0000"  >&lt;p&gt;While looking for the source file for this issue, I also found that &lt;a href=&quot;https://www.mongodb.com/docs/v7.0/reference/sbe/#check-query-explain-results&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;Check Query Explain Results&lt;/a&gt; references using &lt;b&gt;slotBasedPlan&lt;/b&gt;&#160;(and subsequently links back to the &lt;a href=&quot;https://www.mongodb.com/docs/v7.0/reference/explain-results/#std-label-explain-results&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;Explain Results&lt;/a&gt; page referenced by this ticket, albeit at a different anchor point).&lt;/p&gt;

&lt;p&gt;Worth mentioning that the ref on &lt;a href=&quot;https://www.mongodb.com/docs/v7.0/reference/sbe/#check-query-explain-results&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;Check Query Explain Results&lt;/a&gt; leads to a note that states:&lt;/p&gt;
&lt;ul&gt;
	&lt;li&gt;Some fields are for internal use and are not documented.&quot;&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;Looking for additional guidance due to this external consideration.&lt;/p&gt;</comment>
                            <comment id="5604827" author="JIRAUSER1264463" created="Tue, 1 Aug 2023 14:19:14 +0000"  >&lt;p&gt;That makes a lot of sense. Sounds good.&lt;/p&gt;</comment>
                            <comment id="5604756" author="jeffrey.allen" created="Tue, 1 Aug 2023 13:58:24 +0000"  >&lt;p&gt;In my opinion, we should retain the docs for this field because users will still see this field in the explain output. I think if users see this field and can&apos;t find any info about it, that&apos;s not a great experience and could lead to questions through the feedback widget.&lt;/p&gt;</comment>
                            <comment id="5603595" author="JIRAUSER1264463" created="Mon, 31 Jul 2023 23:23:18 +0000"  >&lt;p&gt;Thanks &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=eric.sedor%40mongodb.com&quot; class=&quot;user-hover&quot; rel=&quot;eric.sedor@mongodb.com&quot;&gt;eric.sedor@mongodb.com&lt;/a&gt;. Would it be better to simply remove documentation for this field? If we don&apos;t want customers to use it, I&apos;d love to omit documentation all together. WDYT?&#160;&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>7.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_14258" key="com.atlassian.jira.plugin.system.customfieldtypes:datepicker">
                        <customfieldname>Baseline start date</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Mon, 18 Dec 2023 00:00:00 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10055" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>Date of 1st Reply</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Mon, 31 Jul 2023 23:23:18 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10052" key="com.atlassian.jira.toolkit:dayslastcommented">
                        <customfieldname>Days since reply</customfieldname>
                        <customfieldvalues>
                                        7 weeks, 2 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_14876" key="com.atlassian.jira.plugin.system.customfieldtypes:userpicker">
                        <customfieldname>Docs Reviewer</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>jeffrey.allen@mongodb.com</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>
    
                        </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>
                            7 weeks, 2 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>jeffrey.allen@mongodb.com</customfieldvalue>
            <customfieldvalue>matt.maville@mongodb.com</customfieldvalue>
            <customfieldvalue>sarah.olson@mongodb.com</customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                        <customfield id="customfield_14254" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Product Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|i2k7pz:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|i22bag:</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_10555" key="com.atlassian.jira.plugin.system.customfieldtypes:float">
                        <customfieldname>Story Points</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2.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|i2jtvb:</customfieldvalue>

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