Merge pull request OpenDDS#4297 from jrw972/quickstart-migration

DevGuide does not contain quick starts
iguessthislldo · Oct 18, 2023 · d60c34c · d60c34c
2 parents 4a72ce7 + e611009
commit d60c34c
Show file tree

Hide file tree

Showing 40 changed files with 1,620 additions and 354 deletions.
diff --git a/docs/devguide/about.rst b/docs/devguide/about.rst
@@ -0,0 +1,57 @@
+################
+About This Guide
+################
+
+..
+    Sect<0.3>
+
+This Developer's Guide corresponds to OpenDDS version |release|.
+This guide is primarily focused on the specifics of using and configuring OpenDDS to build distributed publish-subscribe applications.
+While it does give a general overview of the OMG Data Distribution Service, this guide is not intended to provide comprehensive coverage of the specification.
+The intent of this guide is to help you become proficient with OpenDDS as quickly as possible.
+Readers are encouraged to submit corrections to this guide using a GitHub pull request.
+The source for this guide can be found at :ghfile:`docs/devguide` and :doc:`/internal/docs` contains guidance for editing and building it.
+
+***********
+Conventions
+***********
+
+..
+    Sect<0.4.2>
+
+This guide uses the following conventions:
+
+.. list-table::
+   :header-rows: 0
+
+   * - ``Fixed pitch text``
+
+     - Indicates example code or information a user would enter using a keyboard.
+
+   * - *Italic text*
+
+     - Indicates a point of emphasis.
+
+   * - ...
+
+     - An ellipsis indicates a section of omitted text.
+
+************
+``DDS_ROOT``
+************
+
+This guide refers to the :envvar:`DDS_ROOT` environment variable which should point to the base directory of the OpenDDS distribution.
+Often, this will be written as ``$DDS_ROOT`` indicating the value of the environment variable.
+
+********
+Examples
+********
+
+..
+    Sect<0.5>
+
+The examples in this guide are intended for the learning of the reader and should not be considered to be "production-ready" code.
+In particular, error handling is sometimes kept to a minimum to help the reader focus on the particular feature or technique that is being presented in the example.
+The source code for all these examples is available as part of the OpenDDS source code distribution in the :ghfile:`DevGuideExamples` directory.
+MPC files are provided with the examples for generating build-tool specific files, such as GNU Makefiles or Visual C++ project and solution files.
+To run an example, execute the ``run_test.pl`` Perl script.
diff --git a/docs/devguide/building/index.rst b/docs/devguide/building/index.rst
@@ -1,3 +1,5 @@
+.. _building:
+
 #######################
 Building and Installing
 #######################

diff --git a/docs/devguide/faq.rst b/docs/devguide/faq.rst
diff --git a/docs/devguide/index.rst b/docs/devguide/index.rst
@@ -6,6 +6,10 @@ The Developer's Guide explains how to use OpenDDS.
 
 .. toctree::
 
+  about
+  quickstart/index
+  introduction_to_dds
+  shapes
   introduction
   building/index
   getting_started
@@ -23,3 +27,4 @@ The Developer's Guide explains how to use OpenDDS.
   dds_security
   internet_enabled_rtps
   xtypes
+  faq