Move the hacking docs out and link to groovydocs properly
This commit is contained in:
parent
f968a2c1c8
commit
e01e699861
|
@ -0,0 +1,23 @@
|
||||||
|
=== Hacking Verspätung
|
||||||
|
|
||||||
|
Verspätung is a link:http://groovy-lang.org[Groovy]-based application which is
|
||||||
|
built with link:http://gradle.org[Gradle]. As such, if you are already familiar
|
||||||
|
with these tools you should be able to find your way around the project with
|
||||||
|
relative ease.
|
||||||
|
|
||||||
|
|
||||||
|
A quick primer on what tasks are available:
|
||||||
|
|
||||||
|
* Running tests: `./gradlew check`
|
||||||
|
* Running the app locally: `./gradlew run -PzookeeperHosts=localhost:2181`
|
||||||
|
* Building the app for distribution: `./gradlew assemble`
|
||||||
|
|
||||||
|
|
||||||
|
=== Releasing Verspätung
|
||||||
|
|
||||||
|
NOTE: This is mostly meant for the developer team.
|
||||||
|
|
||||||
|
Currently releases can be produced by simply pushing a Git tag to this GitHub
|
||||||
|
repository. This will cause Travis CI to build and test the tag, which if it is
|
||||||
|
successful, will automatically publish to
|
||||||
|
link:https://bintray.com/lookout/systems/verspaetung[Bintray].
|
13
README.adoc
13
README.adoc
|
@ -29,16 +29,3 @@ Running Verspätung is rather easy, by default the daemon will monitor the
|
||||||
standard Kafka high-level consumer offset path of `/consumers` and start
|
standard Kafka high-level consumer offset path of `/consumers` and start
|
||||||
reporting deltas automatically.
|
reporting deltas automatically.
|
||||||
|
|
||||||
=== Hacking
|
|
||||||
|
|
||||||
* Running tests: `./gradlew check`
|
|
||||||
* Running the app locally: `./gradlew run -PzookeeperHosts=localhost:2181`
|
|
||||||
* Building the app for distribution: `./gradlew assemble`
|
|
||||||
|
|
||||||
|
|
||||||
=== Releasing
|
|
||||||
|
|
||||||
This is mostly meant for the developer team, but currently releases can be
|
|
||||||
produced by simply pushing a Git tag to this GitHub repository. This will cause
|
|
||||||
Travis CI to build and test the tag, which if it is successful, will
|
|
||||||
automatically publish to link:https://bintray.com/lookout/systems/verspaetung[Bintray].
|
|
||||||
|
|
|
@ -1,6 +1,15 @@
|
||||||
= Verspätung
|
= Verspätung
|
||||||
:toc: right
|
:toc: right
|
||||||
|
|
||||||
== README
|
|
||||||
|
== Overview/Readme
|
||||||
|
|
||||||
include::../../../README.adoc[]
|
include::../../../README.adoc[]
|
||||||
|
|
||||||
|
== Developing
|
||||||
|
|
||||||
|
=== Useful links
|
||||||
|
|
||||||
|
* link:groovydoc/[Internal API docs]
|
||||||
|
|
||||||
|
include::../../../HACKING.adoc[]
|
||||||
|
|
Loading…
Reference in New Issue