Permalink
Browse files

Move documentation to asciidoc

  • Loading branch information...
ctomc committed Nov 27, 2017
1 parent 76ac87e commit aa8a165a78117162d2739005d661cfc639556682
Showing with 15,852 additions and 14,396 deletions.
  1. +246 −0 README.adoc
  2. +0 −143 README.md
  3. +137 −0 RELEASE_PROCEDURE.adoc
  4. +0 −91 RELEASE_PROCEDURE.md
  5. +204 −0 app-client/README.adoc
  6. +0 −180 app-client/README.md
  7. +8 −0 attributes.adoc
  8. +183 −0 batch-processing/README.adoc
  9. +0 −170 batch-processing/README.md
  10. +111 −0 bean-validation-custom-constraint/README.adoc
  11. +0 −96 bean-validation-custom-constraint/README.md
  12. +106 −0 bean-validation/README.adoc
  13. +0 −93 bean-validation/README.md
  14. +108 −0 bmt/README.adoc
  15. +0 −98 bmt/README.md
  16. +52 −0 buildReadmes.sh
  17. +132 −0 cmt/README.adoc
  18. +0 −120 cmt/README.md
  19. +216 −0 contacts-jquerymobile/README.adoc
  20. +0 −184 contacts-jquerymobile/README.md
  21. +0 −82 contacts-jquerymobile/SERVICES.md
  22. +109 −0 deltaspike-authorization/README.adoc
  23. +0 −99 deltaspike-authorization/README.md
  24. +107 −0 deltaspike-beanbuilder/README.adoc
  25. +0 −99 deltaspike-beanbuilder/README.md
  26. +121 −0 deltaspike-projectstage/README.adoc
  27. +0 −106 deltaspike-projectstage/README.md
  28. +118 −0 ejb-asynchronous/README.adoc
  29. +0 −116 ejb-asynchronous/README.md
  30. +105 −0 ejb-in-ear/README.adoc
  31. +0 −96 ejb-in-ear/README.md
  32. +122 −0 ejb-in-war/README.adoc
  33. +0 −109 ejb-in-war/README.md
  34. +220 −0 ejb-multi-server/README.adoc
  35. +0 −293 ejb-multi-server/README.md
  36. +199 −0 ejb-remote/README.adoc
  37. +0 −173 ejb-remote/README.md
  38. +392 −0 ejb-security-context-propagation/README.adoc
  39. +0 −351 ejb-security-context-propagation/README.md
  40. +333 −0 ejb-security-jaas/README.adoc
  41. +0 −302 ejb-security-jaas/README.md
  42. +251 −0 ejb-security-programmatic-auth/README.adoc
  43. +0 −211 ejb-security-programmatic-auth/README.md
  44. +256 −0 ejb-security/README.adoc
  45. +0 −222 ejb-security/README.md
  46. +112 −0 ejb-throws-exception/README.adoc
  47. +0 −104 ejb-throws-exception/README.md
  48. +106 −0 ejb-timer/README.adoc
  49. +0 −95 ejb-timer/README.md
  50. +138 −0 forge-from-scratch/README.adoc
  51. +0 −124 forge-from-scratch/README.md
  52. +102 −0 greeter/README.adoc
  53. +0 −94 greeter/README.md
  54. +189 −0 ha-singleton-deployment/README.adoc
  55. +0 −189 ha-singleton-deployment/README.md
  56. +445 −0 ha-singleton-service/README.adoc
  57. +0 −392 ha-singleton-service/README.md
  58. +26 −14 helloworld-classfiletransformer/{README.md → README.adoc}
  59. +127 −0 helloworld-html5/README.adoc
  60. +0 −140 helloworld-html5/README.md
  61. +248 −0 helloworld-jms/README.adoc
  62. +0 −222 helloworld-jms/README.md
  63. +145 −0 helloworld-mbean/README.adoc
  64. +0 −133 helloworld-mbean/README.md
  65. +198 −0 helloworld-mdb-propertysubstitution/README.adoc
  66. +0 −169 helloworld-mdb-propertysubstitution/README.md
  67. +111 −0 helloworld-mdb/README.adoc
  68. +0 −102 helloworld-mdb/README.md
  69. +454 −0 helloworld-mutual-ssl-secured/README.adoc
  70. +0 −392 helloworld-mutual-ssl-secured/README.md
  71. +382 −0 helloworld-mutual-ssl/README.adoc
  72. +0 −328 helloworld-mutual-ssl/README.md
  73. +95 −0 helloworld-rf/README.adoc
  74. +0 −83 helloworld-rf/README.md
  75. +82 −0 helloworld-rs/README.adoc
  76. +0 −76 helloworld-rs/README.md
  77. +84 −0 helloworld-singleton/README.adoc
  78. +0 −75 helloworld-singleton/README.md
  79. +241 −0 helloworld-ssl/README.adoc
  80. +0 −202 helloworld-ssl/README.md
  81. +125 −0 helloworld-ws/README.adoc
  82. +0 −112 helloworld-ws/README.md
  83. +77 −0 helloworld/README.adoc
  84. +0 −70 helloworld/README.md
  85. +126 −0 hibernate/README.adoc
  86. +0 −113 hibernate/README.md
  87. +123 −0 hibernate4/README.adoc
  88. +0 −110 hibernate4/README.md
  89. +1 −1 hibernate4/pom.xml
  90. +112 −0 inter-app/README.adoc
  91. +0 −100 inter-app/README.md
  92. +157 −0 jaxrs-client/README.adoc
  93. +0 −147 jaxrs-client/README.md
  94. +118 −0 jaxws-addressing/README.adoc
  95. +0 −99 jaxws-addressing/README.md
  96. +126 −0 jaxws-ejb/README.adoc
  97. +0 −107 jaxws-ejb/README.md
  98. +116 −0 jaxws-pojo/README.adoc
  99. +0 −100 jaxws-pojo/README.md
  100. +155 −0 jaxws-retail/README.adoc
  101. +0 −138 jaxws-retail/README.md
  102. +84 −0 jsonp/README.adoc
  103. +0 −78 jsonp/README.md
  104. +209 −0 jta-crash-rec/README.adoc
  105. +0 −185 jta-crash-rec/README.md
  106. +121 −0 jts-distributed-crash-rec/README.adoc
  107. +0 −242 jts-distributed-crash-rec/README.md
  108. +313 −0 jts/README.adoc
  109. +0 −304 jts/README.md
  110. +133 −0 kitchensink-angularjs/README.adoc
  111. +0 −113 kitchensink-angularjs/README.md
  112. +148 −0 kitchensink-ear/README.adoc
  113. +0 −134 kitchensink-ear/README.md
  114. +148 −0 kitchensink-html5-mobile/README.adoc
  115. +0 −126 kitchensink-html5-mobile/README.md
  116. +0 −50 kitchensink-html5-mobile/SERVICES.md
  117. +117 −0 kitchensink-jsp/README.adoc
  118. +0 −102 kitchensink-jsp/README.md
  119. +194 −0 kitchensink-ml/README.adoc
  120. +0 −176 kitchensink-ml/README.md
  121. +89 −0 kitchensink-utjs-angularjs/README.adoc
  122. +0 −72 kitchensink-utjs-angularjs/README.md
  123. +95 −0 kitchensink-utjs-mustache/README.adoc
  124. +0 −81 kitchensink-utjs-mustache/README.md
  125. +108 −0 kitchensink/README.adoc
  126. +0 −97 kitchensink/README.md
  127. +137 −0 logging-tools/README.adoc
  128. +0 −128 logging-tools/README.md
  129. +300 −0 logging/README.adoc
  130. +0 −280 logging/README.md
  131. +195 −0 mail/README.adoc
  132. +0 −175 mail/README.md
  133. +148 −0 managed-executor-service/README.adoc
  134. +0 −134 managed-executor-service/README.md
  135. +467 −0 messaging-clustering-singleton/README.adoc
  136. +0 −435 messaging-clustering-singleton/README.md
  137. +310 −0 messaging-clustering/README.adoc
  138. +0 −284 messaging-clustering/README.md
  139. +79 −0 numberguess/README.adoc
  140. +0 −70 numberguess/README.md
  141. +106 −0 payment-cdi-event/README.adoc
  142. +0 −98 payment-cdi-event/README.md
  143. +41 −93 pom.xml
  144. +89 −0 resteasy-jaxrs-client/README.adoc
  145. +0 −81 resteasy-jaxrs-client/README.md
  146. +365 −0 security-domain-to-domain/README.adoc
  147. +0 −267 security-domain-to-domain/README.md
  148. +88 −0 servlet-async/README.adoc
  149. +0 −79 servlet-async/README.md
  150. +123 −0 servlet-filterlistener/README.adoc
  151. +0 −107 servlet-filterlistener/README.md
  152. +271 −0 servlet-security/README.adoc
  153. +0 −227 servlet-security/README.md
  154. +237 −0 shopping-cart/README.adoc
  155. +0 −201 shopping-cart/README.md
  156. +107 −0 shrinkwrap-resolver/README.adoc
  157. +0 −97 shrinkwrap-resolver/README.md
  158. +129 −0 spring-greeter/README.adoc
  159. +0 −114 spring-greeter/README.md
  160. +116 −0 spring-kitchensink-basic/README.adoc
  161. +0 −101 spring-kitchensink-basic/README.md
  162. +119 −0 spring-kitchensink-springmvctest/README.adoc
  163. +0 −104 spring-kitchensink-springmvctest/README.md
  164. +167 −0 spring-petclinic/README.adoc
  165. +0 −144 spring-petclinic/README.md
  166. +109 −0 spring-resteasy/README.adoc
  167. +0 −91 spring-resteasy/README.md
  168. +116 −0 tasks-jsf/README.adoc
  169. +0 −105 tasks-jsf/README.md
  170. +311 −0 tasks-rs/README.adoc
  171. +0 −267 tasks-rs/README.md
  172. +128 −0 tasks/README.adoc
  173. +0 −116 tasks/README.md
  174. +92 −0 temperature-converter/README.adoc
  175. +0 −83 temperature-converter/README.md
  176. +138 −0 template/README.adoc
  177. +0 −165 template/README.md
  178. +107 −0 thread-racing/README.adoc
  179. +0 −97 thread-racing/README.md
  180. +109 −0 websocket-client/README.adoc
  181. +0 −95 websocket-client/README.md
  182. +90 −0 websocket-endpoint/README.adoc
  183. +0 −86 websocket-endpoint/README.md
  184. +95 −0 websocket-hello/README.adoc
  185. +0 −84 websocket-hello/README.md
  186. +112 −0 wicket-ear/README.adoc
  187. +0 −97 wicket-ear/README.md
  188. +99 −0 wicket-war/README.adoc
  189. +0 −89 wicket-war/README.md
  190. +179 −0 wsat-simple/README.adoc
  191. +0 −162 wsat-simple/README.md
  192. +178 −0 wsba-coordinator-completion-simple/README.adoc
  193. +0 −161 wsba-coordinator-completion-simple/README.md
  194. +174 −0 wsba-participant-completion-simple/README.adoc
  195. +0 −159 wsba-participant-completion-simple/README.md
  196. +105 −0 xml-jaxp/README.adoc
  197. +0 −95 xml-jaxp/README.md
View

Large diffs are not rendered by default.

Oops, something went wrong.
View
143 README.md

This file was deleted.

Oops, something went wrong.
View
@@ -0,0 +1,137 @@
= Quickstarts Release Procedure
== Testing the quickstarts
Most of the quickstarts require starting server in standalone mode. Some require the "standalone-full" profile, some require XTS, some require Postgres and some require other quickstarts to be deployed. Profiles are used in the root POM to separate out these groups, allowing you to test the quickstarts easily. For example, to run those that require only standalone mode:
[source]
----
mvn clean verify wildfly:deploy wildfly:undeploy -Parq-remote -P-requires-postgres,-requires-full,-complex-dependencies,-requires-xts
----
Or, to run those only those quickstarts that require the full profile
[source]
----
mvn clean verify wildfly:deploy wildfly:undeploy -Parq-remote -P-requires-postgres,-default,-complex-dependencies,-requires-xts
----
And so on.
== Quickstarts in other repositories
If the quickstarts are stored in another repository, you may wish to merge them in from there, do this:
.
Add the other repo as a remote
[source]
----
git remote add -f <other repo> <other repo url>
----
.
Merge from the tag in the other repo that you wish to use. It is important to use a tag, to make tracking of history easier. We use a recursive merge strategy, always preferring changes from the other repo, in effect overwriting what we have locally.
[source]
----
git merge <tag> -s recursive -Xtheirs -m "Merge <Other repository name> '<Tag>'"
----
.
Review and push to upstream
[source]
----
git push upstream HEAD:master
----
== Rendering Markdown
The quickstarts use flexmark maven plugin to process the markdown. This builds on the basic markdown syntax, adding support for tables, code highlighting, relaxed code blocks etc). We add a couple of custom piece of markup - [TOC] which allows a table of contents, based on headings, to be added to any file, and [Quickstart-TOC], which adds in a table listing the quickstarts.
Just run
[source]
----
mvn generate-resources -Pdocs
----
To render all markdown files to HTML.
To do proper release with zip file &amp; all markdown files with resolved variables and rendered html files, run
[source]
----
mvn clean install -Drelease
----
Which will also result in zip with all quickstarts in dist/target
== Publishing builds to Maven
. You must have gpg set up and your key registered, as described at hhttp://blog.sonatype.com/people/2010/01/how-to-generate-pgp-signatures-with-maven/[hhttp://blog.sonatype.com/people/2010/01/how-to-generate-pgp-signatures-with-maven/]
.
You must provide a property `gpg.passphrase` in your `settings.xml` in the `release` profile e.g.
[source, xml]
----
<profile>
<id>release</id>
<properties>
<gpg.passphrase>myPassPhrase</gpg.passphrase>
</properties>
</profile>
----
.
You must have a JBoss Nexus account, configured with the server id in `settings.xml` with the id `jboss-releases-repository` e.g.
[source, xml]
----
<server>
<id>jboss-releases-repository</id>
<username>myUserName</username>
<password>myPassword</password>
</server>
----
.
Add `org.sonatype.plugins` plug-in group to your `settings.xml` so the Nexus plug-in can be available for publishing scripts.
[source, xml]
----
<pluginGroups>
<pluginGroup>org.sonatype.plugins</pluginGroup>
</pluginGroups>
----
== Release Procedure
. Make sure you have access to rsync files to `filemgmt.jboss.org/download_htdocs/jbossas`
. Release the archetypes
.
Regenerate the quickstart based on archetypes
[source]
----
dist/release-utils.sh -r
----
.
Release
[source]
----
dist/release.sh -s <old snapshot version> -r <release version>
----
This will update the version number, commit and tag, build the distro zip and upload it to &lt;download.jboss.org&gt;. Then it will reset the version number back to the snapshot version number.
View

This file was deleted.

Oops, something went wrong.
Oops, something went wrong.

0 comments on commit aa8a165

Please sign in to comment.