Add Porting Guide (#961)

ansible · Mar 5, 2024 · 15c45db · 15c45db
1 parent c75b1f6
commit 15c45db
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -16,5 +16,6 @@ Receptor is an overlay network intended to ease the distribution of work across
    getting_started_guide/index
    user_guide/index
    developer_guide
+   porting_guide/index
    roadmap/index
    contributing
diff --git a/docs/source/porting_guide/PORTING_2.rst b/docs/source/porting_guide/PORTING_2.rst
@@ -0,0 +1,61 @@
+--------------------------
+Receptor 2.x Porting Guide
+--------------------------
+
+.. contents::
+   :local:
+
+We suggest you read this page along with the Receptor 2 Changelog to understand what updates you may need to make
+
+^^^^^^^^^^^^^^^^^
+Software Versions
+^^^^^^^^^^^^^^^^^
+
+""
+Go
+""
+TBD
+
+""""""
+Python
+""""""
+TBD
+
+^^^^^^^^
+Features
+^^^^^^^^
+
+""""""""""
+Deprecated
+""""""""""
+TBD
+
+"""""""
+Removed
+"""""""
+TBD
+
+^^^^^^^^^^^^
+Command Line
+^^^^^^^^^^^^
+TBD
+
+^^^^^^^^^^^^^
+Configuration
+^^^^^^^^^^^^^
+TBD
+
+^^^^^^^^^^^^^^^
+Control Service
+^^^^^^^^^^^^^^^
+TBD
+
+^^^^^^^^^
+Netceptor
+^^^^^^^^^
+TBD
+
+^^^^^^^^^^
+Workceptor
+^^^^^^^^^^
+TBD
diff --git a/docs/source/porting_guide/index.rst b/docs/source/porting_guide/index.rst
@@ -0,0 +1,5 @@
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   receptor_porting_index
diff --git a/docs/source/porting_guide/receptor_porting_index.rst b/docs/source/porting_guide/receptor_porting_index.rst
@@ -0,0 +1,12 @@
+=======================
+Receptor Porting Guides
+=======================
+
+This section lists porting guides that can help you in updating your environment from one version of receptor to the next.
+
+.. toctree::
+   :maxdepth: 1
+   :glob:
+   :caption: Receptor Porting Guides
+
+   PORTING_2