James, I wouldn't have a generic Concepts section. I'd reveal and illustrate the Concepts using the examples.
What's SORI? Regards, ___________________________________________________________________________ Arthur Ryman, PhD, DE Chief Architect, Project and Portfolio Management IBM Software, Rational Markham, ON, Canada | Office: 905-413-3077, Cell: 416-939-5063 From: James Conallen/Philadelphia/IBM@IBMUS To: Arthur Ryman <[email protected]> Cc: oslc-core <[email protected]>, [email protected], Dave <[email protected]> Date: 12/03/2010 01:40 PM Subject: Re: [oslc-core] OSLC Primer straw-man outline So how about this for a "hands-on" primer outline: 1. Concepts (RDF resource model, REST service API). 2. Service Discovery Documents (catalog, service provider) maybe a word on authentication (OAuth, basic, form etc.) GET the catalog of services (can be nested). GET service provider documents. Examine pre-defined namespace prefxes. 3. Resource API show how to GET a shape associated with a factory POST a new resource based on what can be accepted by shape GET the resource back (note the server supplied properties), GET with oslc.properties parameter GET an HTML representation of the resource (and render in a browser) GET a UI preview (compact rendering) of the resource. PUT an update to the resource back to the server (maybe define a link to some other resource) DELETE the resource (forget the If headers to force an OSLC error response). 4. Query GET the shape associated with a query capability (assuming there are a number of resources already in the server) execute a few queries look at paging through queries that return a large responses play with oslc.select 5. Delegated UI (select and create) create and select a resource with a delegated UI. (may have to construct some scaffolding if we want to examine in detail the JS messaging going on). Nearly all of this can be demonstrated with Firefox Poster and SORI reference implementation (eventually when the RI is functionally complete it should be able to demo it all). <jim/> jim conallen CAM Lead Architect [email protected] Rational Software, IBM Software Group From: Arthur Ryman <[email protected]> To: Dave <[email protected]> Cc: oslc-core <[email protected]>, [email protected] Date: 12/03/2010 10:47 AM Subject: Re: [oslc-core] OSLC Primer straw-man outline Sent by: [email protected] Dave, Yes, that's my point about the Primer. As for the other material, that's really more of an editorial decision. You can start with a single Overview doc, but if it gets unwieldy, then split it. I've give the Primer highest priority. I think the Primer would have the most impact on the implementer community. Being a primate, I believe in the "Monkey See, Monkey Do" approach to learning software technology. :-) Regards, ___________________________________________________________________________ Arthur Ryman, PhD, DE Chief Architect, Project and Portfolio Management IBM Software, Rational Markham, ON, Canada | Office: 905-413-3077, Cell: 416-939-5063 From: Dave <[email protected]> To: oslc-core <[email protected]> Date: 12/03/2010 10:17 AM Subject: Re: [oslc-core] OSLC Primer straw-man outline Sent by: [email protected] I didn't respond to Steve's suggestion of multiple documents: New to OSLC Architecture Implementers OSLC Domains OSLC Community I think Arthur's point was that the primer should be to-the-point with concrete examples, so of your suggestions, I think only the Implementors doc would be called the OSLC Primer. A architecture document could be useful, but I think we need more overview and introductory material first. And, so I'd like to combine the New to OSLC, Architecture, Domains and Community topics into one overview. That's why I like the two document approach: OSLC Primer and OSLC (Technical?) Overview. - Dave On Fri, Dec 3, 2010 at 9:32 AM, Dave <[email protected]> wrote: > Arthur, Thanks for being very specific. > > Seems that we need two documents: > - OSLC Overview > - OSLC Primer > > As you can see from my proposed outline, I think both are high > priority concerns and deserve to be completed at one time as one > document or a pair of documents. > > What do others think about priority? Should we focus exclusively on a > Primer first, or push both ideas forward now? > > - Dave _______________________________________________ Oslc-Core mailing list [email protected] http://open-services.net/mailman/listinfo/oslc-core_open-services.net _______________________________________________ Oslc-Core mailing list [email protected] http://open-services.net/mailman/listinfo/oslc-core_open-services.net
