Thanks largely to @darthsteven, we have some pretty good documentation about using contexts and such. I just reviewed our Developer Manual, along with our API docs, and the relevant base classes and, of course, our example code. Unfortunately, I'm still pretty confused about the relationships between Context, Config and Service classes, and when it's appropriate to use each. Also, what are the relationships, if any, between these classes and hostingService, and all its subclasses? It's worth noting that the hostingService class doesn't have a single line of documentation.

I'm still pretty new to working on Aegir's core, and to object-oriented programming in general, so maybe I'm just missing some background knowledge that'll make all of this obvious. However, it's currently making what should otherwise be a pretty straight-forward feature implementation very frustrating. In contrib, I probably would have just written out the relevant config files in some post hook, but since this is intended to be a core feature, I'm trying to do it The Right Way.

Comments

ergonlogic’s picture

Ideally, this documentation, along with some of the pages from the Developer manual could be moved into the Hosting code and linked to from our index.php. This allows us to ship our developer documentation with our code (and thus version control it), and aggregate most such docs on api.aegirproject.org

anarcat’s picture

agreed, go :)

ergonlogic’s picture

Version: 6.x-2.x-dev » 7.x-3.x-dev
Issue summary: View changes

Ideally we'll move dev docs into the code so that we can centralize them on http://api.aegirproject.org