[DOCS-13015] $group docs improvements Created: 05/Sep/19  Updated: 30/Oct/23  Resolved: 20/Sep/19

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: Jeffrey Allen
Resolution: Fixed Votes: 0
Labels: docs-agg-improv
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Cloners
is cloned by DOCS-13043 $unwind docs improvements Closed
Participants:
Days since reply: 4 years, 19 weeks, 5 days ago
Epic Link: DOCSP-1769

 Description   

Description

Improve the $group operator page:

Scope of changes

(some combination/permutations):

  • Add multi-stage examples. Check some existing examples in docs for use of group. Where appropriate, show the results of each individual stage. Utilize common datasets for multiple examples where we can.
  • Order examples such that common use cases appear first. (Counting documents is the most common use case for $group)
  • For each example, make sure we provide a command to insert the sample documents so users can follow along. Each example should follow the form: Sample Documents, Aggregation, Results.
  • If possible, include $cond.
  • Add some SQL comparison examples. Show group by having.
  • Double check the language to vet out the unclear/ambiguous/etc.

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 27/Sep/19 ]

Author:

{'username': 'jeff-allen-mongo', 'email': 'jeffrey.allen@10gen.com', 'name': 'jeff-allen-mongo'}

Message: (DOCS-13015): Improvements to agg page

updates per kay's feedback

Splitting last example into two stages

reformatting

typo fixes and cleanup

Updates per Kay's feedback
Branch: v3.6
https://github.com/mongodb/docs/commit/4d659596ecbe9f318c322af3f3fa6562adaf1475

Comment by Githook User [ 20/Sep/19 ]

Author:

{'name': 'jeff-allen-mongo', 'username': 'jeff-allen-mongo', 'email': 'jeffrey.allen@10gen.com'}

Message: (DOCS-13015): Improvements to agg page

updates per kay's feedback

Splitting last example into two stages

reformatting

typo fixes and cleanup

Updates per Kay's feedback
Branch: v4.0
https://github.com/mongodb/docs/commit/49a4164206027907334e5a557ac8fd2d53fa9664

Comment by Jeffrey Allen [ 20/Sep/19 ]

Changes merged and published.

Comment by Githook User [ 20/Sep/19 ]

Author:

{'username': 'jeff-allen-mongo', 'email': 'jeffrey.allen@10gen.com', 'name': 'jeff-allen-mongo'}

Message: (DOCS-13015): Improvements to agg page

updates per kay's feedback

Splitting last example into two stages

reformatting

typo fixes and cleanup

Updates per Kay's feedback
Branch: master
https://github.com/mongodb/docs/commit/44e7fa973f6b53c6c10e6e9fb0097b98693b4806

Generated at Thu Feb 08 08:06:43 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.