Bugzilla – Full Text Bug Listing
| Summary: | developer guide needs clearer distinction between "services" and "extension services" | ||
|---|---|---|---|
| Product: | [ECD] Orion | Reporter: | Susan McCourt <susan> |
| Component: | Doc | Assignee: | John Arthorne <john.arthorne> |
| Status: | RESOLVED FIXED | QA Contact: | |
| Severity: | normal | ||
| Priority: | P3 | CC: | simon_kaegi, susan |
| Version: | 0.4 | ||
| Target Milestone: | 0.4 RC3 | ||
| Hardware: | PC | ||
| OS: | Windows 7 | ||
| Whiteboard: | |||
John, I can help with this if you want, but assigning to you for now because I'm not sure if anything needs to be done on the build help side... We can definitely reorganize, but I'm not convinced about a solid distinction between "extension services" and "deep internal services". In theory most or all service should be implementable from a plugin. For example Simon has a plugin that implements orion.core.file, and maybe also orion.core.preference. In any case I'm ok with a section like "plugging into Orion pages" similar to how we have "Plugin into the Orion editor". There is some build work here.. in general each new wiki page needs a line added to a build script to include it. http://git.eclipse.org/c/orion/org.eclipse.orion.server.git/commit/?id=4061fe91d7c85e1cd74023871891597fbfbce65a I didn't clearly define a concept of "extension services", but I pulled out the services you suggested into a "Plugging into Orion pages" section as you suggested. I agree it reads much better. |
Now that we have more extension points, I'm finding the organization of the developer guide somewhat confusing in the way it organizes the services description. It mixes and matches "services you could reimplement if you were deep inside Orion" and "service extension points you can put in a plug-in." I think this could really confuse someone learning the system. For example: Core client services orion.core.favorite orion.core.file orion.core.linkScanner orion.core.marker orion.core.preference orion.core.textlink As a plugin-provider I probably care about linkScanner and marker, but not so much about the others. In fact, having textlink and linkScanner in the same list is a bit confusing. Likewise: User interface services orion.page.selection orion.page.command orion.page.dialog orion.page.message orion.page.link same problem. We could simply add a "plugging into orion pages" section and then move: orion.core.linkScanner orion.core.link orion.core.link.related into that section?