Add README.md

VESPA-6223

21 files changed, 61 insertions, 0 deletions

diff --git a/bundle-plugin-test/README.md b/bundle-plugin-test/README.md
new file mode 100644
index 00000000000..23f9655b978
--- /dev/null
+++ b/bundle-plugin-test/README.md
@@ -0,0 +1,3 @@
+# Bundle plugin test
+
+Integration tests for the JDisc bundle plugin.
diff --git a/bundle-plugin/README.md b/bundle-plugin/README.md
new file mode 100644
index 00000000000..057fd29ada7
--- /dev/null
+++ b/bundle-plugin/README.md
@@ -0,0 +1,3 @@
+# JDisc bundle plugin
+
+Maven plugin for building OSGi bundles for JDisc.
diff --git a/component/README.md b/component/README.md
new file mode 100644
index 00000000000..202b2233c13
--- /dev/null
+++ b/component/README.md
@@ -0,0 +1,3 @@
+# Component library
+
+Library for components with lifecycle and versioning.
diff --git a/config-lib/README.md b/config-lib/README.md
new file mode 100644
index 00000000000..bfc2a4c4596
--- /dev/null
+++ b/config-lib/README.md
@@ -0,0 +1,4 @@
+# Library for generated config classes
+
+Base library for generated cloud config classes.
+
diff --git a/container-core/README.md b/container-core/README.md
new file mode 100644
index 00000000000..7e304587ca3
--- /dev/null
+++ b/container-core/README.md
@@ -0,0 +1,3 @@
+# Container core
+
+This module contains various core classes for JDisc container.
diff --git a/container-dev-builder/README.md b/container-dev-builder/README.md
new file mode 100644
index 00000000000..13c77dc808c
--- /dev/null
+++ b/container-dev-builder/README.md
@@ -0,0 +1,3 @@
+# container-dev-builder
+
+TODO
diff --git a/container-dev/README.md b/container-dev/README.md
new file mode 100644
index 00000000000..597d52f3113
--- /dev/null
+++ b/container-dev/README.md
@@ -0,0 +1,3 @@
+# Container development maven dependency
+
+Maven dependency for internal Vespa modules that should be built as JDisc bundles.
diff --git a/container-di/README.md b/container-di/README.md
new file mode 100644
index 00000000000..e261c2bcfe5
--- /dev/null
+++ b/container-di/README.md
@@ -0,0 +1,3 @@
+# Container DI
+
+JDisc's dependency injection framework.
diff --git a/container-disc/README.md b/container-disc/README.md
new file mode 100644
index 00000000000..54f575ff353
--- /dev/null
+++ b/container-disc/README.md
@@ -0,0 +1,3 @@
+JDisc container internal integration
+
+JDisc container integration layer with jdisc_core.
diff --git a/container-jersey2/README.md b/container-jersey2/README.md
new file mode 100644
index 00000000000..f3fb2fdb468
--- /dev/null
+++ b/container-jersey2/README.md
@@ -0,0 +1,3 @@
+# JDisc Jersey integration
+
+The integration layer between JDisc and Jersey2.
diff --git a/container-search-and-docproc/README.md b/container-search-and-docproc/README.md
new file mode 100644
index 00000000000..fff041175bb
--- /dev/null
+++ b/container-search-and-docproc/README.md
@@ -0,0 +1,6 @@
+# Container search and docproc bundle
+
+Pacakges the search and document processing modules for JDisc
+into one bundle.
+
+This modules also contains the `ApplicationStatus` handler.
diff --git a/container-test-jars/README.md b/container-test-jars/README.md
new file mode 100644
index 00000000000..e38f7951b8e
--- /dev/null
+++ b/container-test-jars/README.md
@@ -0,0 +1,3 @@
+# Container test bundles
+
+Used by the 'application' module.
diff --git a/container/README.md b/container/README.md
new file mode 100644
index 00000000000..56172c49787
--- /dev/null
+++ b/container/README.md
@@ -0,0 +1,5 @@
+# Container
+
+Convenience dependency for users developing OSGi bundles for JDisc.
+Add this maven module as dependency in your pom.xml, and it will
+transitively pull in all dependencies needed to develop JDisc bundles.
diff --git a/jdisc_core/README.md b/jdisc_core/README.md
new file mode 100644
index 00000000000..4a1561d6ce7
--- /dev/null
+++ b/jdisc_core/README.md
@@ -0,0 +1,3 @@
+# JDisc core
+
+The most basic part of JDisc.
diff --git a/jdisc_core_test/README.md b/jdisc_core_test/README.md
new file mode 100644
index 00000000000..8e5022648e4
--- /dev/null
+++ b/jdisc_core_test/README.md
@@ -0,0 +1 @@
+# Tests for jdisc core
diff --git a/jdisc_jmx_metrics/README.md b/jdisc_jmx_metrics/README.md
new file mode 100644
index 00000000000..5f813b961b2
--- /dev/null
+++ b/jdisc_jmx_metrics/README.md
@@ -0,0 +1 @@
+# JMX metrics for JDisc
diff --git a/jdisc_messagebus_service/README.md b/jdisc_messagebus_service/README.md
new file mode 100644
index 00000000000..19fb93ed3f3
--- /dev/null
+++ b/jdisc_messagebus_service/README.md
@@ -0,0 +1,3 @@
+# JDisc messagebus service
+
+Messagebus protocol implementation for JDisc.
diff --git a/lifecycle_mapping/README.md b/lifecycle_mapping/README.md
new file mode 100644
index 00000000000..e832fa3ab10
--- /dev/null
+++ b/lifecycle_mapping/README.md
@@ -0,0 +1 @@
+# ToDo
diff --git a/provided-dependencies/README.md b/provided-dependencies/README.md
new file mode 100644
index 00000000000..bd510f266ff
--- /dev/null
+++ b/provided-dependencies/README.md
@@ -0,0 +1,3 @@
+# JDisc provided dependencies
+
+Dependencies that are installed in JDisc and should not be included in artifacts with dependencies.
diff --git a/socket_test/README.md b/socket_test/README.md
new file mode 100644
index 00000000000..e832fa3ab10
--- /dev/null
+++ b/socket_test/README.md
@@ -0,0 +1 @@
+# ToDo
diff --git a/vespa-application-maven-plugin/README.md b/vespa-application-maven-plugin/README.md
new file mode 100644
index 00000000000..e9687ef46ce
--- /dev/null
+++ b/vespa-application-maven-plugin/README.md
@@ -0,0 +1,3 @@
+# Vespa application plugin
+
+Maven Plugin for assembling a vespa application package.
\ No newline at end of file