Update JS Docs #497

dplewis · 2018-01-16T06:11:36Z

Closes: parse-community/Parse-SDK-JS#543

Polygon
Schema API
Aggregate and Distinct
Full Text

I'm not the best at explaining so any help would be great.

Also If there are any new JS features I missed I can add them here.

I'll use this as a base for iOS and Android Guides

montymxb

Various changes, questions, clarifications and such. There's probably some other stuff that will need to be caught in a second review once this initial items are addressed.

montymxb · 2018-01-17T21:04:53Z

_includes/js/queries.md

+### Full Text Search
+
+Use `fullText` for efficient search capabilities. Text indexes are automatically created for you. Your strings are turned into tokens for fast searching.
+


I would put the note regarding the 'cost' of full text search ops up here instead. That way it's a disclaimer of sorts as to what kind of impact this may have, before they start seeing any examples.

montymxb · 2018-01-17T21:05:09Z

_includes/js/queries.md

+
+For Case or Diacritic Sensitive search, please use the [REST API](http://docs.parseplatform.org/rest/guide/#queries-on-string-values).
+
+* Note: Full Text Search can be expensive operations.


*this would be the note to move up ^, and maybe with some further clarification as to 'expensive operations'.

montymxb · 2018-01-17T21:07:49Z

_includes/js/queries.md

+ };
+
+// Pipeline array
+const pipeline = [


Should either rename to 'pipelineArray' or change from const to var or let. In the same example you have two constants declared with the same name, and although it's just an example it should probably show correct code 😉 .

montymxb · 2018-01-17T21:08:34Z

_includes/js/queries.md

+
+For a list of available operators please refer to [Mongo Aggregate Documentation](https://docs.mongodb.com/v3.2/reference/operator/aggregation/).
+
+* Note: Most operation in Mongo Aggregate Documentation will work with Parse-Server, but `_id` doesn't exist. Please replace with `objectId`.


typo:

Most operations in...

montymxb · 2018-01-17T21:10:40Z

_includes/js/queries.md

+  });
+</code></pre>
+
+<pre><code class="javascript">


I would add some descriptive text before this code block to detail what's in it, especially since it's only preceded by another block.

montymxb · 2018-01-17T21:21:44Z

_includes/js/schemas.md

+This API allows you to access the schemas of your app.
+
+* `MasterKey` is required.
+* Starting with Parse-Server 2.7.1


Parse-Server thing

montymxb · 2018-01-17T21:22:18Z

_includes/rest/schemas.md

@@ -9,7 +9,7 @@ types in the databrowser.
 This API allows you to access the schemas of your app.
 Note: This API can be only accessed using the `master key`.

-* Starting with Parse-Server 3.0 Index support added.
+* Starting with Parse-Server 2.7.1 Index support added.


Parse-Server thing

montymxb · 2018-01-17T21:23:04Z

_includes/js/schemas.md

+
+Schema will return an object similar to the following:
+
+<pre><code class="javascript">


Wait a minute...this is a duplicate file of schema.md right? Is there a particular reason why this one (or that one) is being added?

montymxb · 2018-01-17T21:23:38Z

assets/js/bundle.js


 				// Animate to the value specified
-				.end().animate({ opacity: to }, speed, easing, callback);
+				().end().animate({ opacity: to }, speed, easing, callback);


Reason for this?

No Idea, I think when I ran bundle install this happened or maybe my text-editor linter.

I'll change it back

That's fine then, so as it's functional.

montymxb · 2018-01-17T21:24:41Z

js.md

@@ -22,6 +22,7 @@ sections:
 - "js/analytics.md"
 - "common/data.md"
 - "common/relations.md"
+- "js/schema.md"


If you're just adding schema.md you might want to drop schemas.md. In the php section I have it setup to reference schema.md already, might as well be consistent.

dplewis · 2018-01-18T02:49:40Z

@montymxb Thanks for the initial review. I went ahead and added some more aggregate examples.

dplewis · 2018-01-18T18:54:09Z

@flovilmart Can you look over this?

flovilmart

I agree with @montymxb comments, otherwise LGTM

montymxb · 2018-01-18T19:36:45Z

_includes/rest/schemas.md

@@ -9,7 +9,7 @@ types in the databrowser.
 This API allows you to access the schemas of your app.
 Note: This API can be only accessed using the `master key`.

-* Starting with Parse-Server 3.0 Index support added.
+* Starting with Parse Server 2.7.1 Index support added.


Didn't even realize the 3.0 thing there...nice catch

montymxb

Alright second look over and it's pretty good! Just some nits here and there.

To note I'm not 100% sure I want to move those locations for server requirements, as I see they're already following the leading paragraph in other sections of the docs. To retract what I put down before, I would use that existing style instead, that and the blue note is fine (and don't worry about the italics). I'll update those comments shortly to reflect this.

montymxb · 2018-01-18T19:41:44Z

_includes/js/geopoints.md

@@ -57,6 +57,38 @@ query.find({
 });
 </code></pre>

+You can query for whether an object lies within / on a polygon of `Parse.GeoPoint` (minimum 3 points):


can probably replace the / with 'or' just to be a bit more explicit.

montymxb · 2018-01-18T19:42:41Z

_includes/js/geopoints.md

+});
+</code></pre>
+
+You can query for whether an object `Parse.Polygon` contains a `Parse.GeoPoint`:


Stylistic

You can also query for whether...

montymxb · 2018-01-18T19:44:05Z

_includes/js/queries.md

@@ -205,6 +205,39 @@ The above example will match any `BarbecueSauce` objects where the value in the

 Queries that have regular expression constraints are very expensive, especially for classes with over 100,000 records. Parse restricts how many such operations can be run on a particular app at any given time.

+### Full Text Search
+
+Use `fullText` for efficient search capabilities. Text indexes are automatically created for you. Your strings are turned into tokens for fast searching.


Stylistic

You can use fullText for efficient...

montymxb · 2018-01-18T19:47:53Z

_includes/js/queries.md

+
+Use `fullText` for efficient search capabilities. Text indexes are automatically created for you. Your strings are turned into tokens for fast searching.
+
+* Note: Full Text Search can be resource expensive. As with all indexes ensure you have enough RAM. Speed comes at a cost.


Stylistic

Note: Full Text Search can be resource intensive. Ensure the cost of using indexes is worth the benefit, see storage requirements & performance costs of text indexes.

montymxb · 2018-01-18T19:50:17Z

_includes/js/queries.md

+
+* Note: Full Text Search can be resource expensive. As with all indexes ensure you have enough RAM. Speed comes at a cost.
+
+Requires Parse Server 2.5.0+


I was wondering about these requirement labels, we should try to standardize them so they're not just dotted around. I think a solution could be to make sure this immediately follows the feature title. In this case ### Full Text Search. Also, and this is just a thought, but maybe we should italicize this entire requirement, just to emphasize it before the reader attempts to start implementing said feature.

Make sure to lead the requirement with * immediately following the introductory paragraph of the feature.

montymxb · 2018-01-18T19:51:56Z

_includes/js/queries.md

+
+Queries can be made using aggregates, allowing you to retrieve objects over a set of input values. The results will not be `Parse.Object`s since you will be aggregating your own fields
+
+* Note: MasterKey is Required. Parse Server 2.7.1+


Same thing here, we should move this statement directly below the title of Aggregate. Should make sure it's similar to the others as well. We can keep the master key requirement in there though, makes sense to have that as well.

~~Also I'm not set in stone on this one. Using an * marks it with a blue + on the docs, and that might be good as is, but location should be standardized below the title.~~

Positioning is good here, but you could break up the masterKey & server requirement, with the server one first.

montymxb · 2018-01-18T19:54:29Z

_includes/js/queries.md

+
+Queries can be made using distinct, allowing you find unique values for a specified field.
+
+* Note: MasterKey is required. Parse Server 2.7.1+


~~same here~~
Could break it up.

montymxb · 2018-01-18T19:55:39Z

_includes/js/schema.md

+This API allows you to access the schemas of your app.
+
+* `MasterKey` is required.
+* Starting with Parse Server 2.7.1


~~same here.~~
Positioning is pretty good here, and the parts are broken up. This how the others should be done as well. Could also stand to flip the order so the server requirement is prioritized before the master key.

montymxb · 2018-01-18T20:03:28Z

Just amended some of those comments in the review.

dplewis · 2018-01-18T20:37:40Z

Thanks again, changes made

montymxb

Looks approved

montymxb · 2018-01-18T23:00:19Z

Thanks again for putting up the PR @dplewis . Guess we'll be seeing a couple for iOS and Android pretty soon too!

Update JS Docs

c4aba31

dplewis mentioned this pull request Jan 16, 2018

Documentation for Aggregate Queries parse-community/Parse-SDK-JS#543

Closed

montymxb suggested changes Jan 17, 2018

View reviewed changes

Added aggregate example and typos

7dca8a3

montymxb added enhancement labels Jan 18, 2018

flovilmart reviewed Jan 18, 2018

View reviewed changes

montymxb reviewed Jan 18, 2018

View reviewed changes

montymxb suggested changes Jan 18, 2018

View reviewed changes

Stylistic Changes

ee60a58

montymxb approved these changes Jan 18, 2018

View reviewed changes

montymxb merged commit 3181215 into parse-community:gh-pages Jan 18, 2018

dplewis deleted the aggregate branch January 19, 2018 14:47

mtrezza added type:docs and removed Documentation labels Sep 24, 2021

		### Full Text Search

		Use `fullText` for efficient search capabilities. Text indexes are automatically created for you. Your strings are turned into tokens for fast searching.


		For Case or Diacritic Sensitive search, please use the [REST API](http://docs.parseplatform.org/rest/guide/#queries-on-string-values).

		* Note: Full Text Search can be expensive operations.


		For a list of available operators please refer to [Mongo Aggregate Documentation](https://docs.mongodb.com/v3.2/reference/operator/aggregation/).

		* Note: Most operation in Mongo Aggregate Documentation will work with Parse-Server, but `_id` doesn't exist. Please replace with `objectId`.


		Schema will return an object similar to the following:

		<pre><code class="javascript">


		Use `fullText` for efficient search capabilities. Text indexes are automatically created for you. Your strings are turned into tokens for fast searching.

		* Note: Full Text Search can be resource expensive. As with all indexes ensure you have enough RAM. Speed comes at a cost.


		* Note: Full Text Search can be resource expensive. As with all indexes ensure you have enough RAM. Speed comes at a cost.

		Requires Parse Server 2.5.0+


		Queries can be made using aggregates, allowing you to retrieve objects over a set of input values. The results will not be `Parse.Object`s since you will be aggregating your own fields

		* Note: MasterKey is Required. Parse Server 2.7.1+


		Queries can be made using distinct, allowing you find unique values for a specified field.

		* Note: MasterKey is required. Parse Server 2.7.1+

Uh oh!

Update JS Docs #497

Update JS Docs #497

Uh oh!

Conversation

dplewis commented Jan 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

montymxb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dplewis commented Jan 18, 2018

Uh oh!

dplewis commented Jan 18, 2018

Uh oh!

flovilmart left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

montymxb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

montymxb Jan 18, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

montymxb Jan 18, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

montymxb Jan 18, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

montymxb Jan 18, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

montymxb commented Jan 18, 2018

Uh oh!

dplewis commented Jan 18, 2018

Uh oh!

montymxb left a comment

dplewis commented Jan 16, 2018 •

edited

Loading

montymxb Jan 18, 2018 •

edited

Loading

montymxb Jan 18, 2018 •

edited

Loading

montymxb Jan 18, 2018 •

edited

Loading

montymxb Jan 18, 2018 •

edited

Loading