DOCSP-10251 doc updates for custom delimiters in path (#23)

* DOCSP-10251 doc updates for custom delimiters in path

Author: kanchana-mongodb

source/includes/fact-path-delimiter.rst

@@ -0,0 +1,5 @@
+.. note:: 
+
+   When specifying the 
+   :datalakeconf:`~databases.[n].collections.[n].dataSources.[n].path`, use the 
+   delimiter specified in :datalakeconf:`~stores.[n].delimiter`.

source/reference/cli/stores/create-store.txt

@@ -110,7 +110,7 @@ Parameters
 
          * - ``delimiter`` 
            - string 
-           - Character used to define the separation of elements in the ``prefix``. 
+           - Character used to separate path segments in the {+data-lake-store+}. 
              If ommitted, defaults to ``"/"``.
            - no
 

source/reference/config-files/data-lake-configuration.txt

@@ -378,8 +378,15 @@ The {+data-lake-short+} configuration file has the following format:
 
       .. datalakeconf:: stores.[n].delimiter
 
-         *Optional.* Delimiter that defines the separation of elements in the
-         :datalakeconf:`~stores.[n].prefix`. 
+         *Optional.* The delimiter that separates 
+         :datalakeconf:`databases.[n].collections.[n].dataSources.[n].path` 
+         segments in the {+data-lake-store+}. |data-lake| uses the delimiter 
+         to efficiently traverse |s3| buckets with a hierarchical directory 
+         structure. You can specify any character supported by the |s3| `object 
+         keys <https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html>`__ 
+         as the delimiter. For example, you can specify an underscore (``_``) or a 
+         plus sign (``+``) or multiple characters such as double underscores (``__``) 
+         as the delimiter.
 
          If omitted, defaults to ``"/"``.
 
@@ -586,6 +593,8 @@ The {+data-lake-short+} configuration file has the following format:
 
          See :ref:`datalake-path-syntax` for more information.
 
+         .. include:: /includes/fact-path-delimiter.rst
+
       .. datalakeconf:: databases.[n].collections.[n].dataSources.[n].defaultFormat
 
          *Optional.* Specifies the default format {+data-lake-short+} assumes

source/reference/examples/path-syntax-examples.txt

@@ -88,6 +88,8 @@ to the following:
 In the above example, ``startDate`` is interpreted as a string. For more 
 information on all supported data types, see :ref:`datalake-path-attribute-types`. 
 
+.. include:: /includes/fact-path-delimiter.rst
+
 .. _datalake-path-syntax-egs:
 
 Examples 

source/supported-unsupported/supported-partition-attributes.txt

@@ -8,11 +8,12 @@ Supported Partition Attribute Types
 
 .. include:: /includes/fact-data-lake-beta.rst
 
-The following table lists the supported data types for partition attributes 
-in the :datalakeconf:`~databases.[n].collections.[n].dataSources.[n].path` and 
+The following table lists the supported data types for partition attributes and 
 an example :datalakeconf:`~databases.[n].collections.[n].dataSources.[n].path` 
 for each data type:
 
+.. include:: /includes/fact-path-delimiter.rst
+
 .. list-table::
    :header-rows: 1
    :widths: 10 30 60