On Fri, May 21, 2010 at 10:13 AM, kelvin goodson <[email protected]> wrote: > I'd like to be able to reference a website documentation on the > concept of a "launcher", but I don't think that's an SCA spec > concept; I think it's a Tuscany thing - am I right? If so, then > adding a section to [1] is muddying the water, as currently all the > headings in that page are all true SCA spec concepts. I can develop a > page something like "Tuscany SCA concepts", but my key requirement > here is the reference from the samples readme that will go out with > the release, so to a degree I'm more concerned about getting the > website structure right, rather than the content at this very moment. > Would it seem natural to extend the SCA introduction page with tuscany > concepts, or to make a fresh page? Alternatively we could have a > glossary page. That would allow me to sidestep the issue, as in such > a page it would be fine to have a mixture of the concepts and just be > clear in the description whether the item being described was a > tuscany or an SCA concept. > > thoughts? > > Kelvin. > > [1] > https://cwiki.apache.org/confluence/display/TUSCANYxDOCx2x/SCA+Introduction > > On Thu, May 20, 2010 at 2:17 PM, Simon Laws <[email protected]> wrote: >> On Thu, May 20, 2010 at 1:47 PM, kelvin goodson <[email protected]> >> wrote: >>> I found a definition of a contribution at [1], so I'll update the >>> samples README to talk about contributions and launchers. I guess I >>> will either find or create a paragraph about launchers and reference >>> it in the same way. >>> >>> Isuppose that the README is going to have to be in 2 parts, one part >>> that talks about the new approach of separation into >>> launchers/contributions and the other part which talks about those >>> samples that remain in the existing arrangement for M5. >>> >>> Kelvin. >>> >>> >>> >>> [1] >>> https://cwiki.apache.org/confluence/display/TUSCANYxDOCx2x/SCA+Introduction#SCAIntroduction-scacontribution. >>> >>> >> >> >> Right, M5 is a milestone so I don't see any harm in presenting a work >> in progress. >> >> Simon >> >> -- >> Apache Tuscany committer: tuscany.apache.org >> Co-author of a book about Tuscany and SCA: tuscanyinaction.com >> >
I would try and be as generic as you can with links as I'm sure detailed web links/structure will change in the future. For example, a link the 2.x documentation page is reasonable. We need to make it obvious from there where people need to look for specific information. If it's not then we aren't doing a very good job with the web site. On the questions about pages. I can't get to the site at the moment for some reason but it would seem sensible to separate Tuscany concepts from SCA specific concepts. I would also seem useful to have a glossary. On the specific point about launchers. Launchers are just convenience programs that we use to start the Tuscany runtime in circumstances where there is nothing else to provide a main(). For example, in a web container we would expect the container to provide the main() so we don't have a launcher. Simon -- Apache Tuscany committer: tuscany.apache.org Co-author of a book about Tuscany and SCA: tuscanyinaction.com
