(DOCSP-19710) FAQ (#7)

Author: biniona-mongodb

snooty.toml

@@ -10,6 +10,8 @@ product-package-name = "MongoDB.Analyzer"
 product-version = "1.0"
 product-version-full = "{+product-version+}.0"
 product-settings-file-constant = "mongodb.analyzer.json"
+product-jira = "TODO: Link to project people should submit issues to"
+
 query-api = "MongoDB Query API"
 
 driver-long = "MongoDB .NET driver"

source/configuration.txt

@@ -170,7 +170,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
-have enabled telemetry, see the `FAQ <TODO: link to this question in FAQ>`__
+have enabled telemetry, see the :ref:`FAQ <mongodb-analyzer-all-telemetry-collected>`
 page.
 
 To learn more about how MongoDB Inc. uses collected data, see the

source/faq.txt

@@ -1,3 +1,68 @@
 .. _mongodb-analyzer-faq:
 
-TODO: write
+==========================
+Frequently Asked Questions
+==========================
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+Does the {+product+} support JetBrains Rider?
+--------------------------------------------------
+
+No, the {+product+} does not officially support JetBrains Rider.
+
+We have internally tested the {+product+} on JetBrains Rider and have seen some
+success though. We welcome you to test the {+product+} on your JetBrains Rider deployment,
+and if you encounter any problems feel free to file an 
+`issue on JIRA <{+product-jira+}>`__
+or submit a pull request on the 
+`{+product+} Github repository <{+product-source-repo+}>`__.
+
+Is the {+product+} a Roslyn Analyzer?
+------------------------------------------
+
+Yes, the {+product+} is a Roslyn Analyzer.
+
+To learn more about Roslyn Analyzers, see 
+`Overview of Source Code Analysis <https://docs.microsoft.com/en-us/visualstudio/code-quality/roslyn-analyzers-overview?view=vs-2022>`__
+from Microsoft.
+
+Does the {+product+} Use Custom Serialization Settings?
+------------------------------------------------------------
+
+No, the {+product+} does not use the custom seriliazation settings you specify for your
+{+driver-long+}.
+
+To learn more about custom serilization settings, see 
+`Serialization <{+driver-docs+}reference/bson/serialization/>`__
+in the {+driver-short+} documentation.
+
+Does the {+product+} use custom LINQ settings?
+---------------------------------------------------
+
+No, the {+product+} does not use custom LINQ settings.
+
+To learn more about custom LINQ settings, see
+`How to add custom methods for LINQ queries <https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/linq/how-to-add-custom-methods-for-linq-queries>`__
+from Microsoft.
+
+.. _mongodb-analyzer-all-telemetry-collected:
+
+What information does the {+product+} collect through telemetry?
+---------------------------------------------------------------------
+
+When you have telemetry enabled the {+product+} collects and sends
+anonymized information to MongoDB Inc. The following subsections list all
+information the {+product+} collects.
+
+To learn how to disable telemetry, see the
+:ref:`Configuration <mongodb-analyzer-configuration-telemetry>`
+guide.
+
+.. include:: /includes/telemetry-data.rst

source/includes/telemetry-data.rst

@@ -0,0 +1,64 @@
+
+.. 
+   This file describes all telemetry data collected
+   by the {+product+}. Field names are not included
+   as they are not exposed through the public API.
+
+Your Code
+~~~~~~~~~
+
+The following is the information the {+product+} collects about your code:
+
+- The number of user-defined data types in your
+  `mapping <{+driver-docs+}reference/bson/mapping/>`__
+
+- The number of unsupported LINQ and builder expressions the {+product+} found in your code
+
+- The number of LINQ and builder expressions the {+product+} found in your code
+
+- The number of MQL expressions the {+product+} found in your code
+
+- How long it took for the {+product+} to analyze your code
+
+- The number of exceptions the {+product+} encountered analyzing your code
+
+- The length of the syntax tree the {+product+} processed
+
+Your Environment
+~~~~~~~~~~~~~~~~
+
+The following is the information the {+product+} collects about your environment:
+
+- Your operating system
+
+- The version of the {+product+} you use
+
+- The internal .NET version your IDE or build utility uses to run the {+product+}
+
+- The version of the C# language you use
+
+- The version of the {+driver-long+} you use in your project
+
+- The 
+  `target platform <https://docs.microsoft.com/en-us/visualstudio/ide/understanding-build-platforms?view=vs-2022>`__
+  you use to compile your C# code (AnyCPU/x64/x32)
+
+-  The 
+   `output assembly <https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/output#targettype>`__
+   kind generated by your .NET application
+
+- A unique identifier the {+product+} contructs from a hash of the following components of your
+  `Net User <https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/cc771865(v=ws.11)>`__:
+  
+  - ``UserName``
+  - ``/domain``
+
+Your {+product+} Configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following is the information the {+product+} collects about your {+product+}
+configuration:
+
+- If you have logs enabled for the {+product+}
+
+- The LINQ provider version your {+product+} uses