... {anchor:top}
{section}
{column:width=70%}
{panel:borderStyle=solid|borderColor=#BDBEC0|bgColor=#f5f5f5}
|| Quick Links ||
| [What is Grok?|#WhatIsGrok] |
| [How is Grok organized?|#ResourcesAndProperties] |
| [How do I find resources?|#FindResources] |
| [How do I add a resource?|#AddResource] |
The tag cloud below shows current labels used by the the Java CAPS Wiki with relative popularity indicated by the size of the tag.
{popular-labels:style=heatmap|spaceKey=JavaCAPS}
{listlabels}
{anchor:WhatIsGrok}
h1. What is "Grok Java CAPS"?
[Grok|http://en.wikipedia.org/wiki/Grok] is a term coined by Robert Heinlein to represent thorough understanding of a subject. "Grok Java CAPS" extends Java CAPS product documentation with practical experience that synthesizes multiple topics, including:
* Hands-on exercises that demonstrate key concepts,
* Presentations on various topics,
* Screencasts demonstrating product features,
* Information on how to build solutions using JavaCAPS,
* Core how-to's and workarounds,
* Design guidance,
* Patterns, frameworks, and reference architectures using JavaCAPS, |
| _Grok Java CAPS_ provides a place to store and distribute useful artifacts for learning and using Java CAPS, as well as cross-indexing artifacts in other public sources, such as
[Forums, Blogs,
and Websites]. The goal of Grok is to be a self-indexing set of resources which is easily searchable, extensible, and composable. |
...
[#top]
{anchor:ResourcesAndProperties}
h1. How is Grok organized?
Grok uses an approach modeled after the [Resource Description Framework|http://en.wikipedia.org/wiki/Resource_Description_Framework] used to build the [Semantic Web|http://en.wikipedia.org/wiki/Semantic_web]. The approach is very straightforward.
h2. Resources
Each item in _Grok Java CAPS_ is described in a separate Wiki page, referred here as a "resource", following RDF terminology. Each resource should contain a useful title, a full description of the artifact(s), and attachment(s) as needed. In some cases, the resource will be fully described in its wiki page and require no attachments.
h2. Properties
To facilitate finding and organizing resources, each resource will be tagged with [Confluence labels|http://confluence.atlassian.com/display/DOC/Confluence+User+Guide#ConfluenceUserGuide-WorkingwithLabels]. Labels are always in lowercase. Even if you use uppercase characters, Confluence will convert these to lowercase when it adds the label. Resource labels for Grokker use a 2-part structure. The first part is a property chosen from a set of features of the resource. The second part of the label describes the value of the property in the first part. For example, a label of "type-exercise" indicates that the resource describes an exercise for learning how to use Java CAPS.
To encourage consistency, the properties and values should be constrained to a small set of terms endorsed by the Java CAPS community. This table describes the current set of labels. You are certainly free to use other labels, but when using the "property-value" format, please choose from the following set.
|| Property || Possible \\
\\
Values || Meaning ||
| type | exercise \\
\\
howto \\
\\
feature \\
\\
presentation \\
\\
workshop \\
\\
general \\
\\
wanted | What is the type of the resource? Use "type-wanted" Use "type-wanted" to label a resource which describes an artifact that you would like to be created. to label a resource which describes an artifact that you would like to be created. |
| medium | document \\
\\
screencast \\
\\
agenda \\
\\
deck \\
\\
mail \\
\\
nbproject | What communication medium does the resource use? |
| platform | javacaps \\
\\
openesb | Which platform does the resource describe? \\
\\
Use as many values as apply. |
| container | javaee \\
\\
jbi | Which container does the resource describe? |
| component | otd \\
\\
bridge \\
\\
jcd \\
\\
eway \\
\\
einsight \\
\\
ejb \\
\\
web \\
\\
jcaadapter \\
\\
serviceengine \\
\\
nmr \\
\\
bindingcomponent \\
\\
casa \\
\\
repository | Which component does the resource describe? \\
\\
Some components have a second-level more specific label \\
\\
Resources labeled with "component-eway" may also have labels for specific eWays they use (e.g. "component-sapeway"). \\
\\
Resources labeled with "component-adapter" may also have labels for specific JCA adapters they use (e.g. "component-jmsadapter"). \\
\\
Resources labeled with "component-serviceengine" or "component-bindingcomponent" may also have labels for specific [Open ESB Components|https://open-esb.dev.java.net/Components.html] they use (e.g. "component-iepse"). |
| quality | performance \\
\\
throughput \\
\\
security \\
\\
scalability \\
\\
availability | Which systemic quality does the resource describe? \\
\\
Possible values include any [systemic quality|http://en.wikipedia.org/wiki/Ility]. |
| task | install \\
\\
upgrade \\
\\
design \\
\\
configure \\
\\
deploy \\
\\
monitor \\
\\
administer \\
\\
troubleshoot | Which which task does the resource describe? |
| map | workshop \\
\\
affinity \\
\\
query | Indicates that the resource is a grouping of other resources (including search pages) |
| xref | openesb \\
\\
blog \\
\\
sdn \\
\\
glassfish \\
\\
netbeans \\
\\
other | Indicate resources which are a cross-reference to some other source. |
| author | <screen name>\\ | Indicate original author of the resource |
The first and second part of the label are separated by a dash. For example, the label "type-presentation" indicates that the resource is a presentation about some topic described by other labels. If there is more than one applicable value for a property, then label the resource with multiple property-value labels. For example, if a resource describes something in both JBI and Java EE, it would be labeled with both "container-jbi" and "container-javaee".
[#top]
{anchor:FindResources}
h1. How do I find resources?
There are various methods for to find resources in _Grok Java CAPS_.
h2. Property Links
Confluence provides the ability to search for pages with one or more labels using a simple URL. Use [http://wikis.sun.com/label/JavaCAPS/type-howto] to search for resources that use property-value of "type-howto". Use [http://wikis.sun.com/label/JavaCAPS/component-iepse+type-howto] to search for resources that use both "componenet-iepse" and "type-howto".
h2. Property Searching
There is a [robust search feature available|http://confluence.atlassian.com/display/DOC/Searching+Confluence]. Access to quick search is given in the text box labeled "Search" in the top right corner of every wiki page. To search for resources that use both "componenet-iepse", enter the search string "labelText:component-iepse". The [search syntax|http://confluence.atlassian.com/display/DOC/Confluence+Search+Syntax] provides ability to perform more complicated searches. For example, use the search string "labelText:component-iepse OR labelText:component-bpelse" to search for resources that reference either IEP-SE or BPEL-SE.
h2. Resource Maps
Another way to search for resources is to use Resource Maps. Resource maps are just another resource (i.e. wiki page) with two distinguishing characteristics: 1) Each resource map has the "map\[" property to indicate that the resource is really just a group of resources, 2) The resource map presents a list of groups or search links for related resources. A couple of examples illustrate:
* [Architecture Map] Search for resources from an architectural diagram of Java CAPS showing platforms, containers, and components.
* [Task Map] Search for resources from a task list.
An important type of resource map is a workshop. You can search for these maps using either [type-workshop|http://wikis.sun.com/label/JavaCAPS/type-workshop] or [map-workshop|http://wikis.sun.com/label/JavaCAPS/map-workshop]. Workshop resource maps provide a list of resources in a suggested order to conduct a workshop on Java CAPS. Typically, workshops will reference resources with [type-presentation|http://wikis.sun.com/label/JavaCAPS/type-presentation] and [type-exercise|http://wikis.sun.com/label/JavaCAPS/type-exercise].
{anchor:AddResource}
h1. How do I add a resource?
We are always looking for new resources for _Grok Java CAPS_. Currently, Sun personnel have permission to create new pages and edit existing pages. If you are a Sun partner, customer, or Open ESB user and are interested in contributing to _Grok Java CAPS_, please send a mail message to [mailto:caps-wiki-gov-ext@sun.com].
Follow the steps below to create a new resource.
* [Create a new page|http://confluence.atlassian.com/display/DOC/Creating+a+New+Page] using "Add" ... "Page" menu selection in the upper right of this page. You will be placed in wiki edit mode.
* Give the page an informative name in the text box at the top of the page.
* Describe your new resource with descriptive text. See the Confluence documentation for [instructions on how to edit page content|http://confluence.atlassian.com/display/DOC/Editing+an+Existing+Page]. Including cross-reference URL links as needed, but please be aware that Java CAPS Wiki should only use links that are available on the public Internet.
* [Attach related artifacts|http://confluence.atlassian.com/display/DOC/Working+with+Attachments+Overview]. If the artifact is available on the public internet in a relatively stable location, it is probably better to reference with a URL rather than directly attaching the artifact. If the artifact is maintained on an internal Sun repository, please attach most current copy here.
* [Label your new resource|http://confluence.atlassian.com/display/DOC/Working+with+Labels+Overview] by selecting "Labels:Edit" at the bottom of the page. Please use labels selected from the table above. If you feel you need a new property or new value for an existing property, feel free to add it. However, please try to use existing labels and add new properties or values sparingly.
[#top]
h1. More Information
If you have any questions or comments, please send a mail message to [mailto:caps-wiki-gov-ext@sun.com].
{panel}
{column}
{column:width=30%}
{panel:borderStyle=solid|borderColor=#BDBEC0|titleBGColor=#BDBEC0|bgColor=#ffffff}
[!Images^grok_JavaCAPS_logo_sm.gif!|Grok Java CAPS]
{livesearch:spaceKey=JavaCAPS}
{panel}
{panel:title=Page Table of Contents|borderStyle=solid|borderColor=#BDBEC0|titleBGColor=#BDBEC0|bgColor=#f5f5f5}
{toc:style=disc|indent=20px}
|