<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 07:43:40 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-2537] Update documentation for non-internal commands</title>
                <link>https://jira.mongodb.org/browse/DOCS-2537</link>
                <project id="10380" key="DOCS">Documentation</project>
                    <description>&lt;p&gt;The following commands are labeled internal in the documentation but are considered regular commands.&lt;/p&gt;

&lt;p&gt;captrunc, dbHash, diagLogging, getShardVersion&lt;/p&gt;

&lt;p&gt;These commands should be documented properly and any references to internal be removed.&lt;/p&gt;</description>
                <environment></environment>
        <key id="106190">DOCS-2537</key>
            <summary>Update documentation for non-internal commands</summary>
                <type id="4" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14710&amp;avatarType=issuetype">Improvement</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="sam.kleinman">Sam Kleinman</assignee>
                                    <reporter username="andreas.nilsson">Andreas Nilsson</reporter>
                        <labels>
                    </labels>
                <created>Wed, 15 Jan 2014 16:05:05 +0000</created>
                <updated>Tue, 17 Feb 2015 21:34:46 +0000</updated>
                            <resolved>Tue, 4 Feb 2014 16:55:51 +0000</resolved>
                                    <version>mongodb-2.6</version>
                                    <fixVersion>v1.3.0</fixVersion>
                    <fixVersion>mongodb-2.6</fixVersion>
                                    <component>manual</component>
                        <due></due>
                            <votes>0</votes>
                                    <watches>4</watches>
                                                                                                                <comments>
                            <comment id="493057" author="xgen-internal-githook" created="Tue, 4 Feb 2014 16:57:33 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;tychoish&apos;, u&apos;name&apos;: u&apos;Sam Kleinman&apos;, u&apos;email&apos;: u&apos;samk@10gen.com&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-2537&quot; title=&quot;Update documentation for non-internal commands&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-2537&quot;&gt;&lt;del&gt;DOCS-2537&lt;/del&gt;&lt;/a&gt;: edit internal markers on some commands&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/docs/commit/71b03f642e002a2d2cc740cbac2124511b317cfa&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs/commit/71b03f642e002a2d2cc740cbac2124511b317cfa&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="485080" author="andreas.nilsson@10gen.com" created="Tue, 21 Jan 2014 19:38:51 +0000"  >&lt;p&gt;Ok after discussion with Scott and Andy we decided that these commands should be reasonably documented but not extensively.&lt;/p&gt;

&lt;p&gt;They should also be marked as &quot;used for diagnosis&quot;, &quot;not part of the stable user interfacing API&quot; or something else indicating that we are not guaranteeing forwards compatibility with these commands.&lt;/p&gt;</comment>
                            <comment id="483250" author="andreas.nilsson@10gen.com" created="Thu, 16 Jan 2014 19:17:08 +0000"  >&lt;p&gt;&lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=scotthernandez&quot; class=&quot;user-hover&quot; rel=&quot;scotthernandez&quot;&gt;scotthernandez&lt;/a&gt; I am not sure I agree that there should be two different kinds of internal. Non of the two categories above classify as internal to me. It&apos;s different kinds of external.&lt;/p&gt;

&lt;p&gt;I think there is a lot of confusion regarding the status of many commands that could be alleviated if we were more clear internally and within our docs. &lt;/p&gt;</comment>
                            <comment id="483238" author="scotthernandez" created="Thu, 16 Jan 2014 18:59:48 +0000"  >&lt;p&gt;While these can be used by uses they are still internal commands not meant for the user to run normally and things we consider part of the plumbing not features. Andreas, please remember there is a different between internal wrt/auth(z) and internal wrt/docs-and-users.&lt;/p&gt;

&lt;p&gt;Are you asking these be listed as non-internal on some list relating to security or documented like other &quot;user&quot; commands? Please clarify the title/descr. accordingly.&lt;/p&gt;</comment>
                            <comment id="483056" author="greg_10gen" created="Thu, 16 Jan 2014 14:58:04 +0000"  >&lt;p&gt;WriteBacksQueued is internal, and only should be used by mongos to determine if a shard is eligible as a donor or receiver for chunk migration.&lt;/p&gt;

&lt;p&gt;getShardVersion can be doc&apos;d though, there are diagnostics in there.&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>5.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                    <customfield id="customfield_10855" key="com.atlassian.jira.plugin.system.customfieldtypes:float">
                        <customfieldname>Actual Time</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>4.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10055" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>Date of 1st Reply</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Thu, 16 Jan 2014 14:58:04 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10052" key="com.atlassian.jira.toolkit:dayslastcommented">
                        <customfieldname>Days since reply</customfieldname>
                        <customfieldvalues>
                                        10 years, 2 weeks, 1 day 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_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>jess.mokrzecki@mongodb.com</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_11151" key="com.atlassian.jira.toolkit:LastCommentDate">
                        <customfieldname>Last public comment date</customfieldname>
                        <customfieldvalues>
                            10 years, 2 weeks, 1 day ago
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10051" key="com.atlassian.jira.toolkit:participants">
                        <customfieldname>Participants</customfieldname>
                        <customfieldvalues>
                                        <customfieldvalue>andreas.nilsson</customfieldvalue>
            <customfieldvalue>xgen-internal-githook</customfieldvalue>
            <customfieldvalue>greg_10gen</customfieldvalue>
            <customfieldvalue>sam.kleinman</customfieldvalue>
            <customfieldvalue>scotthernandez</customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                        <customfield id="customfield_14254" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Product Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|hrrfh3:</customfieldvalue>

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

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10558" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>86845</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|hryanz:</customfieldvalue>

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