Add docs building support

[ric-plt/jaegeradapter.git] / docs / overview.rst

diff --git a/docs/overview.rst b/docs/overview.rst
new file mode 100644 (file)
index 0000000..0e4d0fc
--- /dev/null
+++ b/docs/overview.rst
@@ -0,0 +1,33 @@
+..
+.. Copyright (c) 2019 AT&T Intellectual Property.
+..
+.. Copyright (c) 2019 Nokia.
+..
+..
+.. Licensed under the Creative Commons Attribution 4.0 International
+..
+.. Public License (the "License"); you may not use this file except
+..
+.. in compliance with the License. You may obtain a copy of the License at
+..
+..
+..     https://creativecommons.org/licenses/by/4.0/
+..
+..
+.. Unless required by applicable law or agreed to in writing, documentation
+..
+.. distributed under the License is distributed on an "AS IS" BASIS,
+..
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+..
+.. See the License for the specific language governing permissions and
+..
+.. limitations under the License.
+..
+
+
+jaegeradapter Overview
+======================
+
+This repository contains helm charts for deploying a jaeger-all-in-one container.
+In addition, it contains a config map for creating a trace configuration for clients using either ric-plt/tracelibcpp or ric-plt/tracelibgo.