[SERVER-39196] Use command IDLs to generate help text and documentation Created: 25/Jan/19 Updated: 06/Dec/22 |
|
| Status: | Backlog |
| Project: | Core Server |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Major - P3 |
| Reporter: | Louis Williams | Assignee: | Backlog - Service Architecture |
| Resolution: | Unresolved | Votes: | 1 |
| Labels: | sa-remove-fv-backlog-22 | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||
| Assigned Teams: |
Service Arch
|
||||
| Participants: | |||||
| Description |
|
Now that we have detailed IDLs for many server commands, it makes sense for them to generate help() text and also downstream documentation. This would be a better user experience for commands that don't have shell helpers, and would require less work for the Docs team whenever a command changes. |
| Comments |
| Comment by Connie Chen [ 23/Sep/22 ] |
|
emet.ozar@mongodb.com - Service Arch is going to put this in the backlog for now, but if the docs team would find this particularly helpful then please let us know or throw this back into "needs scheduling" and we can re-triage. |
| Comment by Connie Chen [ 07/Sep/22 ] |
|
We decided to close PM-1859 as won't do, so throwing this ticket back into triage |