First version of TOC Tree commit
Change-Id: Id5a1fbe77e36d4fa1cfa9b8568dc5511e9bf4434
diff --git a/.gitreview b/.gitreview
new file mode 100644
index 0000000..8f88f21
--- /dev/null
+++ b/.gitreview
@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2020 Open Networking Foundation <info@opennetworking.org>
+#
+# SPDX-License-Identifier: LicenseRef-ONF-Member-Only-1.0
+
+[gerrit]
+host=gerrit.opencord.org
+port=29418
+project=sdcore-docs.git
+defaultremote=origin
diff --git a/VERSION b/VERSION
index 0d4d124..e708c6f 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-0.1.0-dev
+1.0.0-rc
diff --git a/configuration/config.rst b/configuration/config.rst
new file mode 100644
index 0000000..6d9c11e
--- /dev/null
+++ b/configuration/config.rst
@@ -0,0 +1,10 @@
+Overview
+--------
+Network Slice Configuration
+---------------------------
+
+Device Group Configuration
+--------------------------
+
+UE Provisioning
+---------------
diff --git a/developer/gnbsim.rst b/developer/gnbsim.rst
new file mode 100644
index 0000000..4c32737
--- /dev/null
+++ b/developer/gnbsim.rst
@@ -0,0 +1,2 @@
+Using gNB Simulator
+===================
diff --git a/developer/guide.rst b/developer/guide.rst
new file mode 100644
index 0000000..cf18c40
--- /dev/null
+++ b/developer/guide.rst
@@ -0,0 +1,2 @@
+Developer Guide
+===============
diff --git a/developer/testpod.rst b/developer/testpod.rst
new file mode 100644
index 0000000..9679f74
--- /dev/null
+++ b/developer/testpod.rst
@@ -0,0 +1,5 @@
+TEST POD
+========
+
+How to use testPod
+------------------
diff --git a/dict.txt b/dict.txt
index 12d8ad2..cc26e7b 100644
--- a/dict.txt
+++ b/dict.txt
@@ -13,3 +13,41 @@
sdcore
unsuffixed
virtualenv
+MME
+SPGW
+HSS
+PCRF
+AMF
+SMF
+NRF
+PCF
+AUSF
+NSSF
+UDM
+UDR
+PFCP
+eNB
+gNB
+simapp
+testPod
+3gpp
+Downlink
+Keepalive
+grpc
+hss
+mme
+spgw
+pcrf
+smf
+amf
+nrf
+nssf
+pcf
+udm
+udr
+ausf
+config
+configPod
+gpp
+pcrfdb
+Deregistration
diff --git a/glossary.rst b/glossary.rst
new file mode 100644
index 0000000..ecc4dce
--- /dev/null
+++ b/glossary.rst
@@ -0,0 +1,30 @@
+Glossary
+========
+
+Protocols
+---------
+- NGAP
+- S1AP
+- Diameter
+- NAS
+- PFCP
+- GTPv1
+- GTPv2
+
+Network Functions
+-----------------
+
+- AMF: Access Management Function
+- UPF: User Plane Function
+- SMF: Session Management Function
+- NRF: Network Repository Function
+- NSSF: Network Slice Selection Function
+- PCF: Policy & Charging Function
+- AUSF: Authentication Function
+- UDM: Unified Data Management Function
+- UDR: Unified Data Repository Function
+
+3gpp Interfaces
+---------------
+- N4 : SMF to UPF
+- SBI interface
diff --git a/index.rst b/index.rst
index a86043b..2eae763 100644
--- a/index.rst
+++ b/index.rst
@@ -1,24 +1,71 @@
SD-Core Documentation
=====================
-SD-Core is an ONF's 5G/LTE Core. More information about Aether can be found at
+SD-Core is an ONF's 5G/LTE Core. More information about SD-Core can be found at
the `ONF website <https://opennetworking.org/sd-core/>`_.
Getting Started with SD-Core
----------------------------
+- Learn more about SD-Core
-Here are some useful places to start with SD-Core:
+ - `SD-Core Website <https://opennetworking.org/sd-core/>`_
+ - `SD-Core Whitepaper <https://opennetworking.org/wp-content/uploads/2021/07/SD-Core-Technical-White-Paper-FINAL-1.pdf>`_
+ - `SD-Core Techinar <https://youtu.be/-eQzbSxXgSU>`_
+ - `SD-Core Wiki <https://wiki.opennetworking.org/display/COM/SD-Core>`_
-* Read the most recent :doc:`Release Notes </release/1.0>`.
+- Stay in touch by joining
+
+ - `SD-Core mailing list <https://groups.google.com/a/opennetworking.org/g/sdcore-announce>`_
+ - \#sdcore-dev channel in `ONF Community Slack <https://onf-community.slack.com>`_
+
Community
---------
-Information about participating in the Aether community and development process
+Information about participating in the SD Core community and development process
can be found on the `ONF Wiki
<https://wiki.opennetworking.org/display/COM/SD-Core>`_.
+.. toctree::
+ :maxdepth: 2
+ :caption: Overview
+ :hidden:
+ :glob:
+
+ overview/introduction.rst
+ overview/architecture.rst
+ overview/3gpp-compliance-5g.rst
+ overview/3gpp-compliance-4g.rst
+ overview/faq.rst
+ glossary
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Configuration
+ :hidden:
+ :glob:
+
+ configuration/config.rst
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Troubleshooting Guide
+ :hidden:
+ :glob:
+
+ troubleshooting/flowchart.rst
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Developer Guide
+ :hidden:
+ :glob:
+
+ developer/guide.rst
+ developer/gnbsim.rst
+ developer/testpod.rst
+
.. toctree::
:maxdepth: 2
diff --git a/overview/3gpp-compliance-4g.rst b/overview/3gpp-compliance-4g.rst
new file mode 100644
index 0000000..097e6ed
--- /dev/null
+++ b/overview/3gpp-compliance-4g.rst
@@ -0,0 +1,38 @@
+4G - 3GPP Release Compliance
+============================
+
+MME Compliance
+--------------
+* Interface support
+* Functions supported
+* Functions not supported
+
+SPGW Compliance
+----------------
+* Interface support
+* Functions supported
+* Functions not supported
+
+
+PCRF Compliance
+----------------
+* Interface support
+* Functions supported
+* Functions not supported
+
+
+HSS Compliance
+---------------
+* Interface support
+* Functions supported
+* Functions not supported
+
+SD Core High Level Features supported
+-------------------------------------
+* UE Attach
+* UE Detach
+* Service Request
+* S1 Release
+* Downlink Data Notification
+* eNB s1 handover
+* eNB x2 handover
diff --git a/overview/3gpp-compliance-5g.rst b/overview/3gpp-compliance-5g.rst
new file mode 100644
index 0000000..a9de156
--- /dev/null
+++ b/overview/3gpp-compliance-5g.rst
@@ -0,0 +1,95 @@
+5G - 3GPP Release Compliance
+============================
+
+SMF Compliance
+--------------
+* Interface support
+ * SBI : Yes
+ * UNKNOWN: No
+* Service Supported
+ * PDU Session Management
+* Functions supported
+* Service/Functions not supported
+ * PCF Notify
+
+AMF Compliance
+--------------
+* Interface support
+ * SBI : Yes
+ * UNKNOWN: No
+* Service Supported
+ * PDU Session Management
+* Functions supported
+* Service/Functions not supported
+ * PCF Notify
+
+
+NRF Compliance
+--------------
+* Interface support
+ * SBI : Yes
+ * UNKNOWN: No
+* Service Supported
+ * Network Function Registration/Deregistration
+* Functions supported
+* Service/Functions not supported
+ * Keepalive
+
+
+AUSF Compliance
+---------------
+* Interface support
+ * SBI : Yes
+ * UNKNOWN: No
+* Service Supported
+* Functions supported
+* Service/Functions not supported
+
+
+UDR Compliance
+--------------
+* Interface support
+ * SBI : Yes
+ * UNKNOWN: No
+* Service Supported
+* Functions supported
+* Service/Functions not supported
+
+
+UDM Compliance
+--------------
+* Interface support
+ * SBI : Yes
+ * UNKNOWN: No
+* Service Supported
+* Functions supported
+* Service/Functions not supported
+
+
+NSSF Compliance
+---------------
+* Interface support
+ * SBI : Yes
+ * UNKNOWN: No
+* Service Supported
+* Functions supported
+* Service/Functions not supported
+
+
+PCF Compliance
+--------------
+* Interface support
+ * SBI : Yes
+ * UNKNOWN: No
+* Service Supported
+* Functions supported
+* Service/Functions not supported
+
+
+SD Core High Level Features supported
+-------------------------------------
+
+High Level Features Not supported
+---------------------------------
+* URLLC
+* Location Based Services
diff --git a/overview/architecture.rst b/overview/architecture.rst
new file mode 100644
index 0000000..450b00c
--- /dev/null
+++ b/overview/architecture.rst
@@ -0,0 +1,19 @@
+Architecture
+====================
+
+Architecture Diagram showing SD-Core box
+----------------------------------------
+- Diagram should show ROC interface, Prom interface, UPF interface, gNB/eNB interface
+
+Architecture Diagram of SD-Core 4G block
+----------------------------------------
+- show configPod, config distribution, MongoDB, Cassandra DB, SIMApp..., 4G network Functions
+
+Architecture Diagram of SD-Core 5G block
+----------------------------------------
+- show configPod, config distribution, MongoDB, SIMApp, 5G network functions
+
+Configuration Distribution Architecture
+---------------------------------------
+- how grpc, rest is used to distribute the configuration
+
diff --git a/overview/faq.rst b/overview/faq.rst
new file mode 100644
index 0000000..144696f
--- /dev/null
+++ b/overview/faq.rst
@@ -0,0 +1,2 @@
+FAQs
+====
diff --git a/overview/introduction.rst b/overview/introduction.rst
new file mode 100644
index 0000000..4f04c83
--- /dev/null
+++ b/overview/introduction.rst
@@ -0,0 +1,5 @@
+Introduction
+====================
+* White paper link
+* Community wiki page or meeting details
+* Generic description of SD Core projects...
diff --git a/release/1.0.rst b/release/1.0.rst
index 26539e9..e04e4fc 100644
--- a/release/1.0.rst
+++ b/release/1.0.rst
@@ -26,7 +26,22 @@
Helm Chart Versions and their component charts and containers:
* sdcore-helm-chart: ``0.1.0``
-
* omec-control-plane: ``0.1.0``
-
* hssdb: ``c3po-hssdb:0.1.0``
+ * hss : ``TODO``
+ * pcrf : ``TODO``
+ * pcrfdb : ``TODO``
+ * config4g : ``TODO``
+ * spgw : ``TODO``
+ * mme : ``TODO``
+ * omec-sub-provision: ``TODO``
+ * simapp: ``TODO``
+ * 5g-control-plane: ``TODO``
+ * amf: ``TODO``
+ * smf: ``TODO``
+ * nrf: ``TODO``
+ * nssf: ``TODO``
+ * pcf: ``TODO``
+ * udm: ``TODO``
+ * udr: ``TODO``
+ * ausf: ``TODO``
diff --git a/release/process.rst b/release/process.rst
index 4fce892..bd65cf4 100644
--- a/release/process.rst
+++ b/release/process.rst
@@ -110,7 +110,7 @@
created - this is known as "lazy branching".
-3. Manually cherry-pick to the **sdcore-1.0** branch of the component, incrementing
+3. Manually cherry-pick to the **sdcore-1.0** branch of the component, increment
the patch version, and test with the **sdcore-1.0** version of
sdcore-system-tests and helm charts.
diff --git a/troubleshooting/flowchart.rst b/troubleshooting/flowchart.rst
new file mode 100644
index 0000000..3efe99f
--- /dev/null
+++ b/troubleshooting/flowchart.rst
@@ -0,0 +1,12 @@
+Connectivity Troubleshooting FlowChart
+======================================
+
+4G Metrics
+----------
+- eNB Status
+- Subscriber information: IP address, IMSI
+
+5G metrics
+----------
+- eNB Status
+- Subscriber information: IP address, IMSI