From 15c45db7e50393eaee6ce17bfd42726564aa9a61 Mon Sep 17 00:00:00 2001 From: Thom Carlin Date: Tue, 5 Mar 2024 07:54:01 -0500 Subject: [PATCH] Add Porting Guide (#961) --- docs/source/index.rst | 1 + docs/source/porting_guide/PORTING_2.rst | 61 +++++++++++++++++++ docs/source/porting_guide/index.rst | 5 ++ .../porting_guide/receptor_porting_index.rst | 12 ++++ 4 files changed, 79 insertions(+) create mode 100644 docs/source/porting_guide/PORTING_2.rst create mode 100644 docs/source/porting_guide/index.rst create mode 100644 docs/source/porting_guide/receptor_porting_index.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index fc7ed3fc8..ceb8b4193 100644 --- 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 new file mode 100644 index 000000000..29bff2073 --- /dev/null +++ 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 new file mode 100644 index 000000000..e9c3c10db --- /dev/null +++ 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 new file mode 100644 index 000000000..e93c6504d --- /dev/null +++ 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