[DOCS-13043] $unwind docs improvements Created: 20/Sep/19  Updated: 30/Oct/23  Resolved: 27/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
clones DOCS-13015 $group docs improvements Closed
Participants:
Days since reply: 4 years, 19 weeks, 5 days ago
Epic Link: DOCSP-1769

 Description   

Description

Improve the $unwind operator page. See Scope of Changes for details.

Scope of changes

(some combination/permutations):

  • More clearly define the two different unwind argument syntaxes.
  • Add multi-stage examples. Check some existing examples in docs for use of unwind. 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.
  • 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.
  • Add comments to examples where appropriate.
  • Try out different ways to present the multiple syntax. Have examples which show both the Field Path Operand and Document Operand.
  • ``includeArrayIndex`` and ``preserveNullAndEmptyArrays`` example section is very long. We can split this into either subsections or tabs.
  • In the arguments table, add linkable references. This way we can link to argument descriptions in the copy.
  • Double check the language to vet out the unclear/ambiguous/etc.

Impact to Other Docs

Can check other agg pages which use $unwind in examples for inspiration. Can possibly synchronize examples across multiple agg pages if they use the same stages.

MVP (Work and Date)

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



 Comments   
Comment by Jeffrey Allen [ 27/Sep/19 ]

Also backported to 4.0.

Comment by Jeffrey Allen [ 27/Sep/19 ]

Changes merged

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