summaryrefslogtreecommitdiffstats
path: root/common/checkstyle/asciidoc/Readme.adoc
diff options
context:
space:
mode:
authorMaros Marsalek <mmarsale@cisco.com>2016-09-21 13:51:57 +0200
committerMaros Marsalek <mmarsale@cisco.com>2016-09-26 11:02:04 +0200
commitbc335de41876acd8720dce1030a79b3a7b39c3b1 (patch)
treec3b1b99c72fbcc36db5b7ff3e4c4e37680481eb0 /common/checkstyle/asciidoc/Readme.adoc
parent09df17bb630b5bf594efbd9f869ef17da5e2b6ac (diff)
HONEYCOMB-209 Configure maven site
To produce site for Honeycomb + javadoc asciidoc To build the site: mvn clean install site:attach-descriptor site mvn site:stage -DstagingDirectory=/home/mmarsale/tmp/stage Change-Id: I4246bb09ba02b74a2a9c84ee73f8dba02384fffa Signed-off-by: Maros Marsalek <mmarsale@cisco.com>
Diffstat (limited to 'common/checkstyle/asciidoc/Readme.adoc')
-rw-r--r--common/checkstyle/asciidoc/Readme.adoc6
1 files changed, 6 insertions, 0 deletions
diff --git a/common/checkstyle/asciidoc/Readme.adoc b/common/checkstyle/asciidoc/Readme.adoc
new file mode 100644
index 000000000..7b1d0767f
--- /dev/null
+++ b/common/checkstyle/asciidoc/Readme.adoc
@@ -0,0 +1,6 @@
+= Honeycomb coding resources
+
+* intellij-java-coding-style.xml Can be imported into Intellij IDEA to ensure Honeycomb coding style during development
+* checkstyle.xml Checkstyle config ensuring above Honeycomb coding style
+* checkstyle-license.xml Checkstyle config ensuring Honeycomb license (in HONEYCOMB_LICENSE.txt) header presence
+* checkstyle-logging.xml Checkstyle config ensuring ODL logging standards \ No newline at end of file