Marko doc #621

MarkoMacrometa · 2023-02-01T15:03:14Z

fixing issues with git

…o MarkoDoc

vercel · 2023-02-01T15:03:17Z

@MarkoMacrometa is attempting to deploy a commit to the Team Macrometa Team on Vercel.

A member of the Team first needs to authorize it.

vercel · 2023-02-01T17:30:33Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
docs	✅ Ready (Inspect)	Visit Preview	Feb 1, 2023 at 5:36PM (UTC)

dustinlarimer

@MarkoMacrometa Nice, should we call this a query performance guide?

@diana-macrometa any thoughts on where this should live? Perhaps within the Queries section?

diana-macrometa · 2023-02-01T17:34:46Z

Most likely the Queries and Query Workers section, yes, unless this is queries that you use in stream workers as well.

diana-macrometa · 2023-02-01T20:34:51Z

docs/best-practice/limit-and-offset-vs-cursor-api-and-hasmore.md

@@ -0,0 +1,166 @@
+---
+sidebar_position: 50


Why are there multiple sidebar_positions at 50? Please put them in numerical order, preferably using two-digit numbers (10, 20, 30). This makes it easier to deal add files in later.

diana-macrometa · 2023-02-01T20:36:33Z

Why are these files included in this PR?

diana-macrometa

Guys, I have the sneaking suspicion that I should give you guys a crash course in Docusaurus and documentation at Macrometa. I can show you guys how to make local builds and a few other things that I think will help you a lot as you work on documentation. Please feel free to throw something on my calendar Thursday or Friday.

In the meantime, please put these topics in order, add headings, apply title case, and review the other comments I have put in so far. Also, please take a close look at the intro paragraphs. We want users to be able to quickly understand what the topic is about, and we also want the words to help guide search results, because users like to do web searches to get answers to their questions.

Great content, I am so excited to work with you guys on this!

diana-macrometa · 2023-02-01T20:35:00Z

docs/best-practice/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Best Practice",


Suggested change

"label": "Best Practice",

"label": "Best Practices",

What are these best practices for? Queries? Or a bunch of different things?

All of them are for Queries.

diana-macrometa · 2023-02-01T20:37:58Z

docs/best-practice/limit-and-offset-vs-cursor-api-and-hasmore.md

@@ -0,0 +1,166 @@
+---


Add an index.md file to both folders. This will serve as an introduction. The user will see it when they click the folder in the side menu, so use it to provide context and tell the reader what to expect in this section. It doesn't have to be long.

diana-macrometa · 2023-02-01T20:41:06Z

docs/best-practice/limit-and-offset-vs-cursor-api-and-hasmore.md

+title: LIMIT and OFFSET vs Cursor API and hasMore
+---
+
+Queries that return large volumes of data may require more than one response to provide the complete results. A common method is using the `LIMIT` and `OFFSET` statements in the query. However, this is not the optimized approach. When these options are used, each time the query is invoked query processing is performed. 


Use "might" rather than "may" to refer to the possibility that something could happen. "May" suggests permission, as in, "You may submit that PR."

diana-macrometa · 2023-02-01T20:42:24Z

docs/best-practice/limit-and-offset-vs-cursor-api-and-hasmore.md

+
+The `batchSize` parameter can be set in the `cursor` API to configure the number of documents returned per request. The `batchSize` default is `100` and the maximum value is `1000`. 
+
+**Query with `LIMIT` and `OFFSET`**


Do not use bold in place of headings. The h1 will be set by the topic title, so the next one down in the hierarchy is h2.

# h1 ## h2 ### h3

diana-macrometa · 2023-02-01T20:43:12Z

docs/best-practice/multiple-collections-vs-single-large-collection.md

@@ -0,0 +1,113 @@
+---
+sidebar_position: 50
+title: Multiple collections vs single large collection


Use title case in file names, not sentence case.

Also, this is a long title. How did it look when you built it locally?

diana-macrometa · 2023-02-01T20:46:44Z

docs/best-practice/limit-and-offset-vs-cursor-api-and-hasmore.md

+}
+```
+
+API Reference Docs


This should be a heading.

diana-macrometa · 2023-02-01T20:48:01Z

docs/best-practice/use-o-indexes-for-collect-operation.md

+title: Use of indexes for COLLECT operation
+---
+
+If there is a `COLLECT` operation in the query, the records with similar attribute values are grouped.  Persistent index on the attribute value on which `COLLECT` operation is performed helps to optimize the query. In the following example, the persistent index on the `country` attribute will help to optimize the query.


Suggested change

If there is a `COLLECT` operation in the query, the records with similar attribute values are grouped. Persistent index on the attribute value on which `COLLECT` operation is performed helps to optimize the query. In the following example, the persistent index on the `country` attribute will help to optimize the query.

If there is a `COLLECT` operation in the query, then the records with similar attribute values are grouped. Persistent indexes on the attribute value on which `COLLECT` operation is performed helps to optimize the query. In the following example, the persistent index on the `country` attribute helps to optimize the query.

diana-macrometa · 2023-02-01T20:48:22Z

docs/best-practice/use-of-composite-index.md

@@ -0,0 +1,6 @@
+---
+sidebar_position: 50
+title: Use of composite index


Why is this topic so extremely short?

diana-macrometa · 2023-02-01T20:48:57Z

docs/best-practice/when-indexes-will-not-work/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "When indexes will not work?",


What does this mean?

diana-macrometa · 2023-02-01T20:49:17Z

docs/best-practice/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Best Practice",
+  "position": 125


Why are both folders at position 125?

dustinlarimer

@MarkoMacrometa Can we move this install_nvm.sh script to a separate PR? I'm all for helpful setup scripts, but I'd like to review and discuss this one separately so it doesn't block the content in this PR.

james-macrometa · 2023-02-03T15:16:34Z

@diana-macrometa @dustinlarimer I am performing some edits to merge into Marko's branch. They address many of the requests you have made here.

diana-macrometa · 2023-02-06T15:07:50Z

Even the ones talking about search?

…

On Mon, Feb 6, 2023 at 4:52 AM MarkoMacrometa ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In docs/best-practice/_category_.json <#621 (comment)>: > @@ -0,0 +1,4 @@ +{ + "label": "Best Practice", All of them are for Queries. — Reply to this email directly, view it on GitHub <#621 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AZGDQM2EO4AHV5V6OS4HFXTWWDXYJANCNFSM6AAAAAAUN2YAMM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

MarkoMacrometa and others added 10 commits January 27, 2023 17:36

test

8bc43cf

Practice 1: LIMIT and OFFSET vs Cursor API and hasMore

09db35d

Use the Execution Plan to optimize indexes, other updates and fixes

85f46fa

additional fixes to Execution Plan

250a247

adding practice 3, 4, 5

86f6fc7

Merge branch 'Macrometacorp:main' into MarkoDoc

550d74c

adding practice 6,7,8

c6b6fec

adding rest of doc for best-practice

433d869

complete stage

b70823e

Merge branch 'MarkoDoc' of https://github.com/MarkoMacrometa/docs int…

58d9823

…o MarkoDoc

MarkoMacrometa requested review from diana-macrometa and jamesm-macrometa as code owners February 1, 2023 15:03

MarkoMacrometa requested a review from a user February 1, 2023 15:03

MarkoMacrometa requested a review from dustinlarimer as a code owner February 1, 2023 15:03

dustinlarimer reviewed Feb 1, 2023

View reviewed changes

vercel bot deployed to Preview February 1, 2023 17:36 View deployment

diana-macrometa reviewed Feb 1, 2023

View reviewed changes

diana-macrometa suggested changes Feb 1, 2023

View reviewed changes

dustinlarimer suggested changes Feb 1, 2023

View reviewed changes


		The `batchSize` parameter can be set in the `cursor` API to configure the number of documents returned per request. The `batchSize` default is `100` and the maximum value is `1000`.

		Query with `LIMIT` and `OFFSET`

	If there is a `COLLECT` operation in the query, the records with similar attribute values are grouped. Persistent index on the attribute value on which `COLLECT` operation is performed helps to optimize the query. In the following example, the persistent index on the `country` attribute will help to optimize the query.
	If there is a `COLLECT` operation in the query, then the records with similar attribute values are grouped. Persistent indexes on the attribute value on which `COLLECT` operation is performed helps to optimize the query. In the following example, the persistent index on the `country` attribute helps to optimize the query.

		@@ -0,0 +1,166 @@
		---
		sidebar_position: 50

Marko doc #621

Are you sure you want to change the base?

Marko doc #621

Uh oh!

Conversation

MarkoMacrometa commented Feb 1, 2023

Uh oh!

vercel bot commented Feb 1, 2023

Uh oh!

vercel bot commented Feb 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dustinlarimer left a comment

Choose a reason for hiding this comment

Uh oh!

diana-macrometa commented Feb 1, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

diana-macrometa commented Feb 1, 2023

Uh oh!

diana-macrometa 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!

dustinlarimer left a comment

Choose a reason for hiding this comment

Uh oh!

james-macrometa commented Feb 3, 2023

Uh oh!

diana-macrometa commented Feb 6, 2023 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

vercel bot commented Feb 1, 2023 •

edited

Loading