Documentation for REMReM publish in Opensource. #185
Conversation
|
|
||
| * JDK 8 | ||
| * Tomcat 8 | ||
| * RabbitMQ Server 3.6.x |
There was a problem hiding this comment.
3.6.x or later, right? And perhaps that qualifier applies to the JDK and Tomcat too?
wiki/markdown/cliUsage.md
Outdated
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <th style="text-align: left;">Exit code</th> | ||
| <th style="text-align: left;">Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td>1</td> | ||
| <td>User will get this exit code in case of some error that is not described below</td> | ||
| </tr> | ||
| <tr> | ||
| <td>2</td> | ||
| <td>Some CLI options are missed</td> | ||
| </tr> | ||
| <tr> | ||
| <td>3</td> | ||
| <td>Passed message protocol or message bus configuration are not correct</td> | ||
| </tr> | ||
| <tr> | ||
| <td>4</td> | ||
| <td>Passed file path is wrong. File is not found</td> | ||
| </tr> | ||
| <tr> | ||
| <td>5</td> | ||
| <td>Unable to read content from passed file path</td> | ||
| </tr> | ||
| <tr> | ||
| <td>6</td> | ||
| <td>Unable to read passed JSON string from command line</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> |
There was a problem hiding this comment.
Any particular reason not to use Markdown table markup? It's easier on the eyes if reading the raw .md file and arguably less tedious to maintain.
wiki/markdown/serviceUsage.md
Outdated
|
|
||
| If you are using linux machine, please follow the below steps | ||
|
|
||
| Add the file *application.properties* to *%CATALINA_HOME%\conf* |
There was a problem hiding this comment.
${CATALINA_HOME}/conf or $CATALINA_HOME/conf, not %CATALINA_HOME%\conf.
wiki/markdown/serviceUsage.md
Outdated
| <protocol>.rabbitmq.host: <host name, eg: localhost> | ||
| <protocol>.rabbitmq.port: <port, eg: 5672> | ||
| <protocol>.rabbitmq.username: <username, default for RabbitMQ Server: guest> | ||
| <protocol>.rabbitmq.password: <password, default for RabbitMQ Server: guest> | ||
| <protocol>.rabbitmq.tls: <tls version, is optional> | ||
| <protocol>.rabbitmq.exchangeName: <exchange name, exchange should be already created on RabbitMQ Server> | ||
| <protocol>.rabbitmq.createExchangeIfNotExisting: <create Exchange if not present on RabbitMQ Server> | ||
| <protocol>.rabbitmq.domainId: <domain id, any string> |
There was a problem hiding this comment.
I don't recall exactly how these properties relate to the configurations specified in the rabbitmq.instance.jsonlist property, but unless the latter is set none of the properties above matter. Please see #176 for a description of how confusing all of this is. As I write in that issue I think the configuration interface should be overhauled completely, but the least we can do is document the current interface.
wiki/markdown/cliUsage.md
Outdated
| @@ -0,0 +1,156 @@ | |||
| # REMReM Publish CLI | |||
There was a problem hiding this comment.
move this file to /usage/cli.md
wiki/markdown/serviceUsage.md
Outdated
| @@ -0,0 +1,360 @@ | |||
| # REMReM Publish Service | |||
There was a problem hiding this comment.
move this file to /usage/service.md
wiki/usage/cli.md
Outdated
| @@ -0,0 +1,156 @@ | |||
| # REMReM Publish CLI | |||
wiki/usage/service.md
Outdated
| @@ -0,0 +1,360 @@ | |||
| # REMReM Publish Service | |||
There was a problem hiding this comment.
wiki/markdown/usage/service.md
Applicable Issues
#168
Description of the Change
Alternate Designs
Benefits
Possible Drawbacks
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Signed-off-by: