<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 07:38:01 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-142] New Documentation Review: Shell and JavaScript Interface</title>
                <link>https://jira.mongodb.org/browse/DOCS-142</link>
                <project id="10380" key="DOCS">Documentation</project>
                    <description>&lt;p&gt;Before we publish the new documentation it needs some kind of technical review. The goal is to make sure that the documentation doesn&apos;t create confusion and/or provide misinformation. Any feedback big or small is very welcome, but the main purpose of this review is to make sure that there are no gaping oversights.&lt;/p&gt;

&lt;p&gt;The best way to proceed will be to fork the &amp;lt;&lt;a href=&quot;https://github.com/mongodb/docs&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs&lt;/a&gt;&amp;gt; repository to your own github accounts, make annotations directly in the file (or make changes if you think that will be easier) and then issue a pull request and I&apos;ll merge this content into the docs repo and make the indicated changes. All of the documentation source reStructured Text. Don&apos;t worry about the specific formatting, if you&apos;re not familiar: I can answer any questions and attend to maintaining correct formatting.&lt;/p&gt;

&lt;p&gt;While it may be tempting to make changes and do more line-by-line editing, Kyle and I have found that it may be more efficient to just add lines that begin with &quot;TODO &quot; and instruction between the relevant paragraphs with instructions on the required change or changes.  You can also leave comments about more global issues on this ticket (or in line&lt;img class=&quot;emoticon&quot; src=&quot;https://jira.mongodb.org/images/icons/emoticons/smile.png&quot; height=&quot;16&quot; width=&quot;16&quot; align=&quot;absmiddle&quot; alt=&quot;&quot; border=&quot;0&quot;/&gt; whatever is easier for you. If needed, I will follow up with questions as I make the revisions.&lt;/p&gt;

&lt;p&gt;Below are the paths of several files in the repository that address the shell and JavaScript interface, and I think you&apos;d be the best person to do this review at this time.  If you won&apos;t have time to get to this, please let us know so we can reassign this ticket.&lt;/p&gt;

&lt;ul class=&quot;alternate&quot; type=&quot;square&quot;&gt;
	&lt;li&gt;docs/source/reference/javascript.rst&lt;/li&gt;
	&lt;li&gt;docs/source/reference/mongo.rst&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;If you want to install Sphinx and build the documents locally you can review the docs (more or less) as they&apos;ll appear on the website, feel free. If you&apos;re having problems with getting the docs to build, tell me so I can resolve any issue with the build process and help you get setup.&lt;/p&gt;

&lt;p&gt;&amp;#8211; samk&lt;/p&gt;</description>
                <environment></environment>
        <key id="31241">DOCS-142</key>
            <summary>New Documentation Review: Shell and JavaScript Interface</summary>
                <type id="3" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14718&amp;avatarType=issuetype">Task</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="9">Done</resolution>
                                        <assignee username="richard.kreuter">Richard Kreuter</assignee>
                                    <reporter username="sam.kleinman">Sam Kleinman</reporter>
                        <labels>
                            <label>Review</label>
                    </labels>
                <created>Wed, 22 Feb 2012 16:02:45 +0000</created>
                <updated>Mon, 30 Oct 2023 22:08:09 +0000</updated>
                            <resolved>Wed, 14 Mar 2012 21:24:35 +0000</resolved>
                                                    <fixVersion>Server_Docs_20231030</fixVersion>
                                    <component>manual</component>
                        <due>Thu, 1 Mar 2012 00:00:00 +0000</due>
                            <votes>0</votes>
                                    <watches>0</watches>
                                                                                                                <comments>
                            <comment id="98862" author="samk" created="Wed, 14 Mar 2012 21:24:27 +0000"  >&lt;p&gt;The above commit (&lt;a href=&quot;https://github.com/mongodb/docs/commit/8d09bc3494487a4ebbaf0d69149fcda7a264ac5b&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs/commit/8d09bc3494487a4ebbaf0d69149fcda7a264ac5b&lt;/a&gt;) represents the changes I&apos;ve made in response to your review.&lt;/p&gt;

&lt;p&gt;I&apos;m going to resolve this task now, but we can open it and revisit it if you have any further comments.&lt;/p&gt;</comment>
                            <comment id="98724" author="auto" created="Wed, 14 Mar 2012 17:22:22 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;login&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-142&quot; title=&quot;New Documentation Review: Shell and JavaScript Interface&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-142&quot;&gt;&lt;del&gt;DOCS-142&lt;/del&gt;&lt;/a&gt; clean up to cross referencing and build errors.&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/docs/commit/05d44dfaab1df7d8cd52eb33b75fc489b7a06884&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs/commit/05d44dfaab1df7d8cd52eb33b75fc489b7a06884&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="98723" author="auto" created="Wed, 14 Mar 2012 17:22:20 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;login&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-142&quot; title=&quot;New Documentation Review: Shell and JavaScript Interface&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-142&quot;&gt;&lt;del&gt;DOCS-142&lt;/del&gt;&lt;/a&gt; corrections to javascript file in response to kreuter&apos;s edits&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/docs/commit/8d09bc3494487a4ebbaf0d69149fcda7a264ac5b&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs/commit/8d09bc3494487a4ebbaf0d69149fcda7a264ac5b&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="97333" author="auto" created="Fri, 9 Mar 2012 20:24:36 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;login&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-142&quot; title=&quot;New Documentation Review: Shell and JavaScript Interface&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-142&quot;&gt;&lt;del&gt;DOCS-142&lt;/del&gt;&lt;/a&gt; javscript formating tweak&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/docs/commit/43ffaf7814ea0c21e2dc717439e67350522b6e5c&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs/commit/43ffaf7814ea0c21e2dc717439e67350522b6e5c&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="95462" author="auto" created="Mon, 5 Mar 2012 19:46:00 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;login&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-142&quot; title=&quot;New Documentation Review: Shell and JavaScript Interface&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-142&quot;&gt;&lt;del&gt;DOCS-142&lt;/del&gt;&lt;/a&gt;: fixing JSON/BSON/document terminology imprecision in javascript reference&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/docs/commit/6fa09a7742fb2733bb5b1eef0d14e5b1090b196c&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs/commit/6fa09a7742fb2733bb5b1eef0d14e5b1090b196c&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="94437" author="samk" created="Fri, 2 Mar 2012 00:34:44 +0000"  >&lt;p&gt;I have a commit staged for the rest of the changes to javascript.rst to resolve the document/json issue. If you have annotations/edits staged locally, I&apos;ll hold off to push until after merging those in, otherwise I&apos;ll push later tonight/tomorrow.&lt;/p&gt;</comment>
                            <comment id="94414" author="auto" created="Thu, 1 Mar 2012 23:43:18 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;login&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-142&quot; title=&quot;New Documentation Review: Shell and JavaScript Interface&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-142&quot;&gt;&lt;del&gt;DOCS-142&lt;/del&gt;&lt;/a&gt;: fixing JSON/BSON/document terminology imprecision&lt;/p&gt;

&lt;p&gt;This commit only affects non-/reference/javascript.rst incidences to&lt;br/&gt;
prevent possible conflicts.&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/docs/commit/b432cd8ed7746c0ee26cd897b93eacee8d558185&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs/commit/b432cd8ed7746c0ee26cd897b93eacee8d558185&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="94397" author="richard@10gen.com" created="Thu, 1 Mar 2012 23:20:56 +0000"  >&lt;p&gt;Per request: everywhere the term &quot;JSON&quot; is used in the current draft, it&apos;s not really right.  (Strictly speaking, you&apos;re keying in JavaScript into the shell, and the shell converts JS objects into BSON objects, a.k.a. BSON documents. Syntactically, some BSON documents can be presented in JSON syntax, but most can&apos;t, because BSON contains data types that can&apos;t be printed in JSON.)  &lt;/p&gt;

&lt;p&gt;It&apos;d be better to call the things the database manipulates &quot;documents&quot;, or &quot;BSON documents&quot; if it&apos;s important to emphasize the binary format.&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>8.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10055" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>Date of 1st Reply</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Thu, 1 Mar 2012 23:20:56 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10052" key="com.atlassian.jira.toolkit:dayslastcommented">
                        <customfieldname>Days since reply</customfieldname>
                        <customfieldvalues>
                                        11 years, 49 weeks 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>emet.ozar@mongodb.com</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_11151" key="com.atlassian.jira.toolkit:LastCommentDate">
                        <customfieldname>Last public comment date</customfieldname>
                        <customfieldvalues>
                            11 years, 49 weeks ago
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10051" key="com.atlassian.jira.toolkit:participants">
                        <customfieldname>Participants</customfieldname>
                        <customfieldvalues>
                                        <customfieldvalue>auto</customfieldvalue>
            <customfieldvalue>richard.kreuter</customfieldvalue>
            <customfieldvalue>sam.kleinman</customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                        <customfield id="customfield_14254" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Product Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|hrshtz:</customfieldvalue>

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

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

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