[COMPASS-3467] Update documentation for plugin developers Created: 20/Feb/19 Updated: 28/Jul/22 Resolved: 28/Jul/22 |
|
| Status: | Closed |
| Project: | Compass |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | No version |
| Type: | Task | Priority: | Major - P3 |
| Reporter: | Massimiliano Marcon | Assignee: | Unassigned |
| Resolution: | Won't Do | Votes: | 1 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||
| Story Points: | 3 | ||||||||
| Documentation Changes: | Not Needed | ||||||||
| Sprint: | Iteration Zucchini, Iteration Antelope, Iteration Ragamuffin | ||||||||
| Description |
|
The public guide to create Compass plugins is outdated (entry point is: https://docs.mongodb.com/compass/master/plugins/creating-compass-plugins/). As we would like to include a prize for Best Compass plugin in the World hackathon that is launched today (Feb 20th), we need the documentation to be up to date so developers don't get confused. This includes updating at least on of the basic plugin examples, e.g. https://docs.mongodb.com/compass/master/plugins/tutorial-server-version and remove the other tutorials that are no longer up to date. We can re-add them later. |
| Comments |
| Comment by Massimiliano Marcon [ 28/Jul/22 ] |
|
We have not seen enough traction in the community for the creation of plugins to justify the maintenance and documentation of a public plugin API. Therefore, I am closing this ticket. |
| Comment by Tomasz Zarna [ 04/Sep/20 ] |
|
Is this still in progress? Was there any progress made? We are considering writing a Compass plugin, or even a collection of them, but without a decent documentation this option is less viable. |
| Comment by Paul Denmead [ 07/Jul/19 ] |
|
I too would like to see this rectified. Is there any word from the developers on a potential fix? Or work-around? |