diff --git a/docs/src/reference/docbook/samples.xml b/docs/src/reference/docbook/samples.xml index d7f6bc5ce2..7e55907647 100644 --- a/docs/src/reference/docbook/samples.xml +++ b/docs/src/reference/docbook/samples.xml @@ -10,7 +10,7 @@ Spring Integration distribution. Instead we have switched to a much simpler collaborative model that should promote better community participation and, ideally, more contributions. Samples now have a dedicated Git repository and a dedicated JIRA Issue Tracking system. Sample development will also have its own lifecycle which is not dependent on the - lifecycle of the framework releases although the repository will still be tagged with each major release for compatibility + lifecycle of the framework releases, although the repository will still be tagged with each major release for compatibility reasons. @@ -26,42 +26,110 @@
Where to get Samples - To monitor samples development and to get more information on the repository you can visit the following - URL: http://git.springsource.org/spring-integration/samples - Since we are using Git as the SCM, we should use the proper terminology as well when it comes to the tasks you need to perform to make - samples available locally on your machine. For more information on Git SCM please visit their - website: http://git-scm.com/ + The Spring Integration Samples project is hosted on GitHub. + You can find the repository at: - CLONE samples repository. (For those unfamiliar with Git, this is somewhat the equivalent of a checkout.) + https://github.com/SpringSource/spring-integration-samples - This is the first step you should go through. You must have Git installed on your machine. There are many GUI-based products - available for many platforms. A simple Google search will help you find them. - To clone the Spring Integration samples repository, issue the following at the command line: - mkdir spring-integration-samples -> cd spring-integration-samples -> git clone git://git.springsource.org/spring-integration/samples.git]]> - + In order to check out or clone (Git parlance) the samples, + please make sure you have a Git client installed on your system. + There are several GUI-based products available for many platforms, e.g. + EGit for the Eclipse IDE. + A simple Google search will help you find them. Of course you can also just + use the command line interface for Git. + + + If you need more information on how to install and/or use Git, please visit: + http://git-scm.com/. + + + In order to checkout (clone in Git terms) the Spring Integration samples + repository using the Git command line tool, issue the following commands: + + + + - That is all you need to do. Now you have cloned the entire samples repository. Since the samples repository is a live - repository, you might want to perform periodic "pulls" to get new samples as well as updates to the existing samples. - To get the updates use the git PULL command: - git pull]]> - - - Submit samples or sample requests - - - As mentioned earlier, Spring Integration samples have a dedicated JIRA Issue tracking system. - To submit new sample requests or to submit an actual sample (as an attachment), please visit our JIRA Issue Tracking system: - https://jira.springframework.org/browse/INTSAMPLES. + That is all you need to do in order to clone the entire samples repository + into a directory named spring-integration-samples within + the working directory where you issued that git command. + Since the samples repository is a live repository, you might want to perform + periodic pulls (updates) to get new samples, as well as updates to + the existing samples. In order to do so issue the following git + PULL command: + + + +
+
+ Submitting Samples or Sample Requests + + How can I contribute my own Samples? + + + Github is for social coding: if you want to submit your own code examples + to the Spring Integration Samples project, we encourage contributions + through pull + requests from + forks + of this repository. If you want to contribute code this way, please + reference, if possible, a + JIRA Ticket + that provides some details regarding the provided sample. + + + Sign the contributor license agreement + + Very important: before we can accept your Spring Integration sample, + we will need you to sign the SpringSource contributor license agreement (CLA). + Signing the contributor's agreement does not grant anyone commit rights + to the main repository, but it does mean that we can accept your + contributions, and you will get an author credit if we do. In order to + read and sign the CLA, please go to: + + + + + + As Project, please select Spring Integration. + The Project Lead is Mark Fisher. + + + Code Contribution Process + + For the actual code contribution process, please read the the + Contributor Guidelines for Spring Integration, + they apply for this project as well: + + + + + + This process ensures that every commit gets peer-reviewed. As a matter of + fact, the core committers follow the exact same rules. + We are gratefully looking forward to your Spring Integration Samples! + + + Sample Requests + + + As mentioned earlier, the Spring Integration Samples + project has a dedicated JIRA Issue tracking system. To submit new sample + requests, please visit our JIRA Issue Tracking system: + + + + https://jira.springframework.org/browse/INTSAMPLES. +
Samples Structure - The structure of the samples changed as well. With plans for more samples we realized that some + Starting with Spring Integration 2.0, the structure of the samples + changed as well. With plans for more samples we realized that some samples have different goals than others. While they all share the common goal of showing you how to apply and work with the Spring Integration framework, they also differ in areas where some samples are meant to concentrate on a technical use case while others focus on a business use case, and some samples are all about showcasing various techniques that