Add documentation skeleton

[it/dep.git] / docs / developer-guides.rst

diff --git a/docs/developer-guides.rst b/docs/developer-guides.rst
new file mode 100644 (file)
index 0000000..e3d579d
--- /dev/null
+++ b/docs/developer-guides.rst
@@ -0,0 +1,47 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. ===============LICENSE_START=======================================================
+.. Copyright (C) 2019 AT&T Intellectual Property      
+.. ===================================================================================
+.. This documentation file is distributed under the Creative Commons Attribution 
+.. 4.0 International License (the "License"); you may not use this file except in 
+.. compliance with the License.  You may obtain a copy of the License at
+..
+.. http://creativecommons.org/licenses/by/4.0
+..
+.. This file 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.
+.. ===============LICENSE_END=========================================================
+
+.. contents::
+   :depth: 3
+   :local:
+
+Developer-Guides
+================
+
+
+.. note:
+..   * This section is used to describe what a contributor needs to know in order to work on the componenta
+
+..   * this should be very technical, aimed at people who want to help develop the components
+
+..   * this should be how the component does what it does, not a requirements document of what the component should do
+
+..   * this should contain what language(s) and frameworks are used, with versions
+
+..   * this should contain how to obtain the code, where to look at work items (Jira tickets), how to get started developing
+   
+..   * This note must be removed after content has been added.
+
+
+Processes
+---------
+
+
+
+Actions
+-------
+