Add short product name constant (#61)

Author: jordan-smith721

README.rst

@@ -2,7 +2,7 @@
 {+product+} Documentation
 =================================
 
-This repository contains documentation for the {+product+}.
+This repository contains documentation for the {+product-short+}.
 
 File JIRA Tickets
 -----------------

snooty.toml

@@ -4,6 +4,7 @@ toc_landing_pages = ["/analyze-code"]
 
 [constants]
 product = "MongoDB C# Analyzer"
+product-short = "C# Analyzer"
 product-source-repo = "https://github.com/mongodb/mongo-csharp-analyzer"
 # The home page is the project's Github repo for the time being. This may change
 # to a DevRel article or product page such as

source/analyze-code.txt

@@ -19,8 +19,8 @@ Analyze Your Code
 Overview
 --------
 
-Learn how to use the {+product+} to analyze your {+driver-long+} code.
-The {+product+} can analyze expressions created with the following patterns:
+Learn how to use the {+product-short+} to analyze your {+driver-long+} code.
+The {+product-short+} can analyze expressions created with the following patterns:
 
 - :ref:`Builders Class <mongodb-analyzer-analyze-builders>`
 - :ref:`Language Integrated Query (LINQ) <mongodb-analyzer-analyze-linq>`
@@ -29,16 +29,16 @@ The {+product+} can analyze expressions created with the following patterns:
 Use the {+product+} From the Command Line
 -------------------------------------------------
 
-To run the {+product+} from the command line and save your results to a 
+To run the {+product-short+} from the command line and save your results to a 
 :github:`SARIF </microsoft/sarif-tutorials/blob/main/docs/1-Introduction.md>`
 format file, perform the following actions:
 
-- Install the {+product+} as described in the :ref:`Install <mongodb-analyzer-install>` guide.
+- Install the {+product-short+} as described in the :ref:`Install <mongodb-analyzer-install>` guide.
 - Execute the following command:
 
 .. code-block:: shell
 
-   dotnet build -property:ErrorLog=<Path to save your {+product+} report>
+   dotnet build -property:ErrorLog=<Path to save your {+product-short+} report>
 
 To learn more about ``dotnet build``, see 
 `.NET Fundamentals <https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-build>`__

source/code-type/builders.txt

@@ -23,7 +23,7 @@ To learn more about builders, see
 Translate into the {+query-api+}
 ------------------------------------
 
-Use the {+product+} to translate your builder expressions into the {+query-api+}.
+Use the {+product-short+} to translate your builder expressions into the {+query-api+}.
 Click the following tabs to see an example of a builder expression
 and its corresponding {+query-api+} translation:
 
@@ -56,7 +56,7 @@ Analyze Builders in Visual Studio
 
 To analyze your builder expressions in Visual Studio, perform the following actions:
 
-1. Install the {+product+} as described in the :ref:`Install <mongodb-analyzer-install>`
+1. Install the {+product-short+} as described in the :ref:`Install <mongodb-analyzer-install>`
    guide.
 #. Write a builder expression with the {+driver-short+}
 #. Move your mouse over the :guilabel:`...` annotation beneath the first
@@ -86,7 +86,7 @@ with or without an information message displayed:
 Track Builder Variables
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-The {+product+} supports builder variable tracking and composition. You can
+The {+product-short+} supports builder variable tracking and composition. You can
 combine multiple builder expressions with `logical operators
 <https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/operators/boolean-logical-operators>`__
 and view the {+query-api+} translation in the information message.
@@ -111,7 +111,7 @@ with or without an information message displayed:
 Fluent API
 ~~~~~~~~~~
 
-The {+product+} supports the Fluent API using builder classes in the {+driver-short+}. You can
+The {+product-short+} supports the Fluent API using builder classes in the {+driver-short+}. You can
 create a sequence of chained builder methods and view the {+query-api+} translation in
 the information message.
 

source/code-type/linq.txt

@@ -28,7 +28,7 @@ To learn more about aggregation pipelines, see
 
 .. note:: Runtime Differences 
 
-   Although the {+query-api+} translations generated by the {+product+} have the same 
+   Although the {+query-api+} translations generated by the {+product-short+} have the same 
    :manual:`query shape </reference/glossary/#std-term-query-shape>`
    as your runtime {+driver-short+}
    queries, there may be slight differences due to the following
@@ -37,15 +37,15 @@ To learn more about aggregation pipelines, see
    - Your Serialization Settings
    - Your LINQ Settings
 
-   The difference between the translations the {+product+} generates
+   The difference between the translations the {+product-short+} generates
    and your queries at runtime should not impact your ability to analyze
    and debug your code.
 
    To learn more about serialization and LINQ settings, see the 
    :ref:`FAQ <mongodb-analyzer-faq-custom-serialization>`
    page.
 
-Use the {+product+} to learn the following
+Use the {+product-short+} to learn the following
 about your LINQ expressions:
 
 - How your LINQ expressions translate into the {+query-api+}
@@ -91,7 +91,7 @@ Analyze LINQ in Visual Studio
 
 To analyze your LINQ expressions in Visual Studio, perform the following actions:
 
-1. Install the {+product+} as described in the :ref:`Install <mongodb-analyzer-install>`
+1. Install the {+product-short+} as described in the :ref:`Install <mongodb-analyzer-install>`
    guide.
 #. Write a LINQ expression with the {+driver-short+}.
 #. Move your mouse over the :guilabel:`...` annotation beneath the first
@@ -101,7 +101,7 @@ To analyze your LINQ expressions in Visual Studio, perform the following actions
 Simple LINQ Expressions
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-The {+product+} analyzes LINQ expressions in the following syntax types:
+The {+product-short+} analyzes LINQ expressions in the following syntax types:
 
 - Method syntax
 - Query syntax
@@ -145,11 +145,11 @@ syntax with or without an information message displayed:
 Unsupported LINQ Expressions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-If your LINQ expression is not supported, the {+product+} outputs a
+If your LINQ expression is not supported, the {+product-short+} outputs a
 ``NotSupportedLinqExpression`` warning.
 
 Click the following tabs to see a code snippet containing an unsupported LINQ expression
-and the corresponding warning message displayed by the {+product+}:
+and the corresponding warning message displayed by the {+product-short+}:
 
 .. tabs::
 
@@ -162,7 +162,7 @@ and the corresponding warning message displayed by the {+product+}:
 
          var result = queryableColl.Where(b => b.GetHashCode() == 167);
 
-      The following screenshot shows the annotation displayed by the {+product+}
+      The following screenshot shows the annotation displayed by the {+product-short+}
       underneath the preceding code snippet in Visual Studio:
 
       .. figure:: /includes/images/linq-unsupported.png
@@ -171,7 +171,7 @@ and the corresponding warning message displayed by the {+product+}:
    .. tab:: Warning
       :tabid: warning
 
-      The following is the warning generated by the {+product+}:
+      The following is the warning generated by the {+product-short+}:
 
       .. code-block:: text
          :copyable: false
@@ -193,18 +193,18 @@ To view more examples of unsupported LINQ expressions, see the
 Analyze LINQ3
 ~~~~~~~~~~~~~
 
-To analyze a LINQ3 expression, you must configure the {+product+} to use the LINQ3
+To analyze a LINQ3 expression, you must configure the {+product-short+} to use the LINQ3
 provider. To learn how to configure your LINQ provider, see the
 :ref:`configuration <mongodb-analyzer-configuration>` guide.
 
 .. important:: Expressions Supported Only by LINQ3
 
-   If your {+driver-short+} version supports LINQ3 but you configure your {+product+} to use
-   the default LINQ provider (LINQ2), the {+product+} informs you if your LINQ expression
+   If your {+driver-short+} version supports LINQ3 but you configure your {+product-short+} to use
+   the default LINQ provider (LINQ2), the {+product-short+} informs you if your LINQ expression
    is supported by LINQ3 but not LINQ2.
 
    Click the tabs to see a LINQ expression supported by LINQ3 but not LINQ2 and the
-   corresponding warning output by the {+product+}:
+   corresponding warning output by the {+product-short+}:
 
    .. tabs::
 

source/code-type/pocos.txt

@@ -16,7 +16,7 @@ Overview
 Plain old CLR objects, or plain old class objects (POCOs), are
 simple class objects that don't
 inherit features from any framework-specific base classes or interfaces.
-If your application uses POCOs, you can use the {+product+} to preview them as JSON
+If your application uses POCOs, you can use the {+product-short+} to preview them as JSON
 objects.
 
 To learn more about POCOs, see the :wikipedia:`POCOs page on Wikipedia <Plain_old_CLR_object>`
@@ -62,7 +62,7 @@ POCOs in JSON, you can see how BSON serialization attributes, such as ``BsonId``
 
 .. tip:: Sample Data
 
-   The {+product+} includes predefined sample values for certain common property names.
+   The {+product-short+} includes predefined sample values for certain common property names.
    If you use
    these property names in your POCO, the Analyzer uses the sample values in the JSON
    output. For any property names without predefined sample values, the Analyzer uses a
@@ -77,7 +77,7 @@ Preview POCOs in Visual Studio
 
 To preview your POCOs in Visual Studio, perform the following actions:
 
-1. Install the {+product+} as described in the :ref:`mongodb-analyzer-install`
+1. Install the {+product-short+} as described in the :ref:`mongodb-analyzer-install`
    guide.
 #. Define a POCO class.
 #. Move your cursor over the :guilabel:`...` ellipsis annotation beneath the first
@@ -103,7 +103,7 @@ with or without an information message displayed:
 
       .. tip:: Rule ID
 
-         The information message begins with the {+product+} Rule ID that generated the 
+         The information message begins with the {+product-short+} Rule ID that generated the 
          popup. In the previous example, the Rule ID is ``MAPoco1001``, indicating
          the POCO is valid. To learn more about this rule, see the
          :ref:`mongodb-analyzer-rules` guide.

source/configuration.txt

@@ -13,18 +13,18 @@ Configure the {+product+}
 Overview
 --------
 
-Learn how to configure the {+product+} in your .NET project and what
+Learn how to configure the {+product-short+} in your .NET project and what
 configuration options are available.
 
 Configuration
 -------------
 
-To configure the {+product+}, perform the following actions:
+To configure the {+product-short+}, perform the following actions:
 
-#. Install the {+product+} as described in
+#. Install the {+product-short+} as described in
    :ref:`the installation guide <mongodb-analyzer-install>`.
 
-#. Create a file specifying your configuration for the {+product+} named
+#. Create a file specifying your configuration for the {+product-short+} named
    ``{+product-settings-file-constant+}``.
 
    .. important:: Naming
@@ -33,7 +33,7 @@ To configure the {+product+}, perform the following actions:
 
 #. Add your configuration to your ``{+product-settings-file-constant+}`` file.
 
-   The following sample configuration makes the {+product+} use the 
+   The following sample configuration makes the {+product-short+} use the 
    `LINQ3 <{+driver-docs+}/fundamentals/linq/>`__
    provider.
 
@@ -51,7 +51,7 @@ To configure the {+product+}, perform the following actions:
 
 .. note:: Configuration is Optional
 
-   If you do not specify a configuration file, the {+product+} uses
+   If you do not specify a configuration file, the {+product-short+} uses
    the default value for all 
    :ref:`configuration options <mongodb-analyzer-configuration-options>`.
 
@@ -69,7 +69,7 @@ Options
 -------
 
 The following is a description of all configuration options supported
-by the {+product+}:
+by the {+product-short+}:
 
 .. list-table::
    :header-rows: 1
@@ -81,7 +81,7 @@ by the {+product+}:
    * - | **DefaultLinqVersion**
      - | **Type:** string
        |
-       | **Description:** The LINQ provider the {+product+} uses.
+       | **Description:** The LINQ provider the {+product-short+} uses.
 
        .. tip::
 
@@ -95,7 +95,7 @@ by the {+product+}:
    * - | **EnableVariableTracking**
      - | **Type:** boolean
        |
-       | **Description:** Specifies if the {+product+} tracks and composes builder
+       | **Description:** Specifies if the {+product-short+} tracks and composes builder
          expression variables.
 
        .. tip::
@@ -110,7 +110,7 @@ by the {+product+}:
    * - | **LogFileName**
      - | **Type:** string
        |
-       | **Description:** Specifies the path to which the {+product+} writes its
+       | **Description:** Specifies the path to which the {+product-short+} writes its
          internal logs.
 
        .. include:: includes/logging-admonition.rst       
@@ -121,7 +121,7 @@ by the {+product+}:
    * - | **OutputDriverVersion**
      - | **Type:** boolean
        |
-       | **Description:** Specifies if the {+product+} includes your {+driver-short+}
+       | **Description:** Specifies if the {+product-short+} includes your {+driver-short+}
          version in diagnostic messages.
        |
        | **Accepted Values**: ``true`` or ``false``
@@ -130,7 +130,7 @@ by the {+product+}:
    * - | **OutputInternalExceptions**
      - | **Type:** boolean
        |
-       | **Description:** Specifies if the {+product+} includes internal exceptions in
+       | **Description:** Specifies if the {+product-short+} includes internal exceptions in
          diagnostic messages.
        |
        | **Accepted Values**: ``true`` or ``false``
@@ -139,7 +139,7 @@ by the {+product+}:
    * - | **OutputInternalLogsToFile**
      - | **Type:** boolean
        |
-       | **Description:** Specifies if the {+product+} writes its internal logs to a file.
+       | **Description:** Specifies if the {+product-short+} writes its internal logs to a file.
 
        .. include:: includes/logging-admonition.rst       
 
@@ -149,7 +149,7 @@ by the {+product+}:
    * - | **PocoAnalysisVerbosity**
      - | **Type:** string
        |
-       | **Description:** Specifies which POCOs the {+product+} previews as JSON. You can
+       | **Description:** Specifies which POCOs the {+product-short+} previews as JSON. You can
          set this option to one of the following values:
 
        - ``"All"``: Preview all POCOs
@@ -163,27 +163,27 @@ by the {+product+}:
    * - | **SendTelemetry**
      - | **Type:** boolean
        |
-       | **Description:** Specifies if the {+product+} collects and sends anonymized
+       | **Description:** Specifies if the {+product-short+} collects and sends anonymized
          information to MongoDB Inc. to improve products.
 
        .. tip::
 
-          To learn more about telemetry in the {+product+}, see the
+          To learn more about telemetry in the {+product-short+}, see the
           :ref:`<mongodb-analyzer-configuration-telemetry>`
           section of this guide.
 
        | **Accepted Values**: ``true`` or ``false``
        | **Default**: ``true``
 
-To learn more about the configuration options the {+product+} supports,
+To learn more about the configuration options the {+product-short+} supports,
 see the :github:`{+product+} source code </master/src/MongoDB.Analyzer/Core/Settings/SettingsHelper.cs>`.
 
 .. _mongodb-analyzer-configuration-telemetry:
 
 Telemetry
 ~~~~~~~~~
 
-When the {+product+} analyzes your source code, the tool by default
+When the {+product-short+} analyzes your source code, the tool by default
 collects and sends anonymized information to MongoDB Inc. to improve
 products.
 
@@ -193,7 +193,7 @@ To disable this feature, specify the following option in your configuration file
 
    "SendTelemetry": false
 
-To view a complete list of all information collected by the {+product+} when you
+To view a complete list of all information collected by the {+product-short+} when you
 have enabled telemetry, see the :ref:`FAQ <mongodb-analyzer-all-telemetry-collected>`
 page.