[
https://issues.apache.org/activemq/browse/AMQ-2934?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Robert Liguori updated AMQ-2934:
--------------------------------
Description:
Consider the following tree for the example folder of ActiveMQ:
- activemq.log
- build.xml
-
----conf
- activemq.xml
- log4j.properties
- resin-web.xml
- web.xml
-
----perfharness
- perfharness-activemq.sh
-
----ruby
- catstomp.rb
- listener.rb
- publisher.rb
- README.txt
- stompcat.rb
-
----src
- - CommandLineSupport.java
- - ConsumerTool.java
- - EmbeddedBroker.java
- - jndi.properties
- - log4j-jms.properties
- - Log4jJMSAppenderExample.java
- - ProducerAndConsumerTool.java
- - ProducerTool.java
- - RequesterTool.java
- - StompExample.java
- - TopicListener.java
- - TopicPublisher.java
- -
- ----ddl
----target
- ----classes
- CommandLineSupport.class
- ConsumerTool.class
- EmbeddedBroker.class
- jndi.properties
- log4j-jms.properties
- Log4jJMSAppenderExample.class
- ProducerAndConsumerTool.class
- ProducerTool.class
- RequesterTool.class
- StompExample.class
- TopicListener.class
- TopicPublisher.class
-
----transactions
- build.xml
- README.txt
-
----src
Retailer.java
Supplier.java
TransactionsDemo.java
Vendor.java
Requests:
There is a myriad of examples with various readme files throughout the ActiveMQ
tree, even above the examples folder. Consider the examples having their
readme.txt at their base folder as in done in Servicemix... this is a less
confusing/more-direct model for understanding the intent of the example and
where to go to for help.
Also note that as in the transactions example, it is in a subfolder of another
example. Examples should be in alignment.
Of course, each README.txt file should point to online tutorials where they
exist. And if they don't exist, a supporting issue can be opened for the
creation of one... bring value-added to the learning process.
Thanks for the consideration
was:
Consider the following tree for the example folder of ActiveMQ:
- activemq.log
- build.xml
-
----conf
- activemq.xml
- log4j.properties
- resin-web.xml
- web.xml
-
----perfharness
- perfharness-activemq.sh
-
----ruby
- catstomp.rb
- listener.rb
- publisher.rb
- README.txt
- stompcat.rb
-
----src
- - CommandLineSupport.java
- - ConsumerTool.java
- - EmbeddedBroker.java
- - jndi.properties
- - log4j-jms.properties
- - Log4jJMSAppenderExample.java
- - ProducerAndConsumerTool.java
- - ProducerTool.java
- - RequesterTool.java
- - StompExample.java
- - TopicListener.java
- - TopicPublisher.java
- -
- ----ddl
----target
- ----classes
- CommandLineSupport.class
- ConsumerTool.class
- EmbeddedBroker.class
- jndi.properties
- log4j-jms.properties
- Log4jJMSAppenderExample.class
- ProducerAndConsumerTool.class
- ProducerTool.class
- RequesterTool.class
- StompExample.class
- TopicListener.class
- TopicPublisher.class
-
----transactions
- build.xml
- README.txt
-
----src
Retailer.java
Supplier.java
TransactionsDemo.java
Vendor.java
Requests:
(1) Updating...
(2) The transactions folder appears to have it's own example. There shouldn't
be a unique example project as a subfolder to another example project...
therefore, the directory model needs to be refined.
(3) Since there are several examples, the top-level folder should be changed
from 'example' to 'examples'.
(4) All examples should point to the corresponding online tutorials and/or
associated web page in a README.txt type file. If a tutorials doesn't exist,
issue to create a supporting tutorials would bring sufficient value.
Thanks for the consideration
> ActiveMQ 'example directory'-layout and Tutorial Refinements
> ------------------------------------------------------------
>
> Key: AMQ-2934
> URL: https://issues.apache.org/activemq/browse/AMQ-2934
> Project: ActiveMQ
> Issue Type: Improvement
> Affects Versions: 5.4.1
> Reporter: Robert Liguori
> Priority: Minor
> Original Estimate: 5 days
> Remaining Estimate: 5 days
>
> Consider the following tree for the example folder of ActiveMQ:
> - activemq.log
> - build.xml
> -
> ----conf
> - activemq.xml
> - log4j.properties
> - resin-web.xml
> - web.xml
> -
> ----perfharness
> - perfharness-activemq.sh
> -
> ----ruby
> - catstomp.rb
> - listener.rb
> - publisher.rb
> - README.txt
> - stompcat.rb
> -
> ----src
> - - CommandLineSupport.java
> - - ConsumerTool.java
> - - EmbeddedBroker.java
> - - jndi.properties
> - - log4j-jms.properties
> - - Log4jJMSAppenderExample.java
> - - ProducerAndConsumerTool.java
> - - ProducerTool.java
> - - RequesterTool.java
> - - StompExample.java
> - - TopicListener.java
> - - TopicPublisher.java
> - -
> - ----ddl
> ----target
> - ----classes
> - CommandLineSupport.class
> - ConsumerTool.class
> - EmbeddedBroker.class
> - jndi.properties
> - log4j-jms.properties
> - Log4jJMSAppenderExample.class
> - ProducerAndConsumerTool.class
> - ProducerTool.class
> - RequesterTool.class
> - StompExample.class
> - TopicListener.class
> - TopicPublisher.class
> -
> ----transactions
> - build.xml
> - README.txt
> -
> ----src
> Retailer.java
> Supplier.java
> TransactionsDemo.java
> Vendor.java
> Requests:
> There is a myriad of examples with various readme files throughout the
> ActiveMQ tree, even above the examples folder. Consider the examples having
> their readme.txt at their base folder as in done in Servicemix... this is a
> less confusing/more-direct model for understanding the intent of the example
> and where to go to for help.
> Also note that as in the transactions example, it is in a subfolder of
> another example. Examples should be in alignment.
> Of course, each README.txt file should point to online tutorials where they
> exist. And if they don't exist, a supporting issue can be opened for the
> creation of one... bring value-added to the learning process.
> Thanks for the consideration
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
