diff --git a/README.rst b/README.rst index b5f56a7..3f10824 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,8 @@ -============================== -MongoDB Analyzer Documentation -============================== - -This repository contains documentation for the MongoDB Analyzer. +================================= +{+product+} Documentation +================================= +This repository contains documentation for the {+product+}. File JIRA Tickets ----------------- diff --git a/snooty.toml b/snooty.toml index 53ffef1..e2efa3e 100644 --- a/snooty.toml +++ b/snooty.toml @@ -3,7 +3,7 @@ title = "MongoDB Analyzer" toc_landing_pages = ["/analyze-code"] [constants] -product = "MongoDB Analyzer" +product = "MongoDB 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 diff --git a/source/analyze-code.txt b/source/analyze-code.txt index 9c04f0f..5b09f9f 100644 --- a/source/analyze-code.txt +++ b/source/analyze-code.txt @@ -27,7 +27,7 @@ The {+product+} can analyze expressions created with the following patterns: - :ref:`Plain Old CLR/Class Objects (POCOs) ` Use the {+product+} From the Command Line ----------------------------------------------- +------------------------------------------------- To run the {+product+} from the command line and save your results to a :github:`SARIF ` diff --git a/source/configuration.txt b/source/configuration.txt index 91c1701..470e84b 100644 --- a/source/configuration.txt +++ b/source/configuration.txt @@ -1,8 +1,8 @@ .. _mongodb-analyzer-configuration: -============================== +================================= Configure the {+product+} -============================== +================================= .. contents:: On this page :local: diff --git a/source/faq.txt b/source/faq.txt index 20f0db0..2c9b157 100644 --- a/source/faq.txt +++ b/source/faq.txt @@ -11,7 +11,7 @@ Frequently Asked Questions :class: singlecol Does the {+product+} support JetBrains Rider? --------------------------------------------------- +----------------------------------------------------- No, the {+product+} does not officially support JetBrains Rider. @@ -23,7 +23,7 @@ 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. @@ -34,7 +34,7 @@ from Microsoft. .. _mongodb-analyzer-faq-custom-serialization: Does the {+product+} Use Custom Serialization Settings? ------------------------------------------------------------- +--------------------------------------------------------------- No, the {+product+} does not use the custom serialization settings you specify for your {+driver-long+}. @@ -44,7 +44,7 @@ To learn more about custom serialization settings, see in the {+driver-short+} documentation. Does the {+product+} use custom LINQ settings? ---------------------------------------------------- +------------------------------------------------------ No, the {+product+} does not use custom LINQ settings. @@ -55,7 +55,7 @@ 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 diff --git a/source/includes/telemetry-data.rst b/source/includes/telemetry-data.rst index 81e5b9b..6a6b8c8 100644 --- a/source/includes/telemetry-data.rst +++ b/source/includes/telemetry-data.rst @@ -54,7 +54,7 @@ The following is the information the {+product+} collects about your environment - ``/domain`` Your {+product+} Configuration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following is the information the {+product+} collects about your {+product+} configuration: diff --git a/source/install.txt b/source/install.txt index 30417d8..acdb5cf 100644 --- a/source/install.txt +++ b/source/install.txt @@ -1,7 +1,7 @@ .. _mongodb-analyzer-install: Install the {+product+} ----------------------------- +------------------------------- .. contents:: On this page :local: