Skip to content

Commit

Permalink
DOCSP-32811: rule descriptions (#57)
Browse files Browse the repository at this point in the history
* DOCSP-32811: rule descriptions

* staging test

* table fix

* wip

* wip

* remove redirect

* BD tech review comments 1

* BD suggestion

(cherry picked from commit 8a32e11)
  • Loading branch information
rustagir committed Feb 2, 2024
1 parent 42a692c commit 496eead
Show file tree
Hide file tree
Showing 11 changed files with 389 additions and 24 deletions.
12 changes: 9 additions & 3 deletions config/redirects
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@ define: prefix docs/mongodb-analyzer
define: base https://www.mongodb.com/${prefix}
define: versions v1.0 v1.1 v1.2 v1.3 master

symlink: current -> master

raw: ${prefix}/ -> ${base}/current/
raw: ${prefix}/master -> ${base}/upcoming/

# Redirects for Analyzer Rules
[*-master]: ${prefix}/${version}/rules/ -> ${base}/${version}/
raw: ${prefix}/current/rules/ -> ${base}/current/
[*-master]: ${prefix}/${version}/rules/#MABuilders1001 -> ${base}/${version}/rules/#mabuilders1001
[*-master]: ${prefix}/${version}/rules/#MABuilders2001 -> ${base}/${version}/rules/#mabuilders2001/
[*-master]: ${prefix}/${version}/rules/#MALinq1001 -> ${base}/${version}/rules/#malinq1001
[*-master]: ${prefix}/${version}/rules/#MALinq2001 -> ${base}/${version}/rules/#malinq2001
[*-master]: ${prefix}/${version}/rules/#MALinq2002 -> ${base}/${version}/rules/#malinq2002
[v1.3-master]: ${prefix}/${version}/rules/#MAPoco1001 -> ${base}/${version}/rules/#mapoco1001
[v1.3-master]: ${prefix}/${version}/rules/#MAPoco2001 -> ${base}/${version}/rules/#mapoco2001
3 changes: 2 additions & 1 deletion source/code-type/pocos.txt
Original file line number Diff line number Diff line change
Expand Up @@ -105,4 +105,5 @@ with or without an information message displayed:

The information message begins with the {+product+} Rule ID that generated the
popup. In the previous example, the Rule ID is ``MAPoco1001``, indicating
the POCO is valid.
the POCO is valid. To learn more about this rule, see the
:ref:`mongodb-analyzer-rules` guide.
Binary file added source/includes/images/MABuilders1001-rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/includes/images/MABuilders2001-rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/includes/images/MALinq1001-rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/includes/images/MALinq2001-rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/includes/images/MALinq2002-rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/includes/images/MAPoco1001-rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/includes/images/MAPoco2001-rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 29 additions & 20 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@

Installation </install>
/analyze-code
/rules
Configuration </configuration>
/known-issues
FAQ </faq>
Expand All @@ -22,40 +23,48 @@
Overview
--------

The `{+product+} <{+product-home-page+}>`__ is a tool
that helps you understand the following about your {+driver-long+}
code:
The {+product+} is a tool that helps you understand the following
aspects of your {+driver-long+} code:

- How your code translates into the {+query-api+}
- If your code includes unsupported LINQ or builder expressions
- How your POCOs serialize to JSON
- How your POCO instances serialize to JSON format

The {+product+} can analyze the following groups of {+driver-short+} expressions and
classes:
.. note:: Roslyn Analyzer

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.

Supported Analysis
~~~~~~~~~~~~~~~~~~

The {+product+} can analyze the following groups of {+driver-short+}
expressions and classes:

- `Builders <{+driver-docs+}/fundamentals/builders/>`__
- `LINQ <{+driver-docs+}/fundamentals/linq/>`__
- `POCOs <{+driver-docs+}/fundamentals/data-formats/poco/>`__

Read the following sections of this guide to learn how to install the
{+product+}, how to use its features, and how to configure it:
Guides
------

- :ref:`Install the extension <mongodb-analyzer-install>`
- :ref:`Analyze your code <mongodb-analyzer-analyze-code>`
- :ref:`Configure the extension <mongodb-analyzer-configuration>`
View the following guides to learn how to install and
configure the {+product+} and how to use its features:

- :ref:`Installation <mongodb-analyzer-install>`
- :ref:`Analyze Your Code <mongodb-analyzer-analyze-code>`
- :ref:`Rules and Message Content <mongodb-analyzer-rules>`
- :ref:`Configuration <mongodb-analyzer-configuration>`

To view known issues with the {+product+}'s current functionality, see
the :ref:`mongodb-analyzer-known-issues` page.
the :ref:`mongodb-analyzer-known-issues` page.

To view answers to frequently asked questions, see the :ref:`FAQ <mongodb-analyzer-faq>` page.
To view answers to frequently asked questions, see the :ref:`FAQ
<mongodb-analyzer-faq>` page.

To view the differences between versions of the extension,
see the :ref:`What's New <mongodb-analyzer-changelog>` page.

For further support, see the :ref:`Issues and Help <mongodb-analyzer-issues-and-help>` page.

.. note:: Roslyn Analyzer

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.
For further support, see the :ref:`Issues and Help
<mongodb-analyzer-issues-and-help>` page.
Loading

0 comments on commit 496eead

Please sign in to comment.