Skip to content

Commit 8a32e11

Browse files
authored
DOCSP-32811: rule descriptions (#57)
* DOCSP-32811: rule descriptions * staging test * table fix * wip * wip * remove redirect * BD tech review comments 1 * BD suggestion
1 parent a20e7c8 commit 8a32e11

File tree

11 files changed

+389
-24
lines changed

11 files changed

+389
-24
lines changed

config/redirects

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,15 @@ define: prefix docs/mongodb-analyzer
22
define: base https://www.mongodb.com/${prefix}
33
define: versions v1.0 v1.1 v1.2 v1.3 master
44

5+
symlink: current -> master
6+
57
raw: ${prefix}/ -> ${base}/current/
68
raw: ${prefix}/master -> ${base}/upcoming/
79

8-
# Redirects for Analyzer Rules
9-
[*-master]: ${prefix}/${version}/rules/ -> ${base}/${version}/
10-
raw: ${prefix}/current/rules/ -> ${base}/current/
10+
[*-master]: ${prefix}/${version}/rules/#MABuilders1001 -> ${base}/${version}/rules/#mabuilders1001
11+
[*-master]: ${prefix}/${version}/rules/#MABuilders2001 -> ${base}/${version}/rules/#mabuilders2001/
12+
[*-master]: ${prefix}/${version}/rules/#MALinq1001 -> ${base}/${version}/rules/#malinq1001
13+
[*-master]: ${prefix}/${version}/rules/#MALinq2001 -> ${base}/${version}/rules/#malinq2001
14+
[*-master]: ${prefix}/${version}/rules/#MALinq2002 -> ${base}/${version}/rules/#malinq2002
15+
[v1.3-master]: ${prefix}/${version}/rules/#MAPoco1001 -> ${base}/${version}/rules/#mapoco1001
16+
[v1.3-master]: ${prefix}/${version}/rules/#MAPoco2001 -> ${base}/${version}/rules/#mapoco2001

source/code-type/pocos.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,5 @@ with or without an information message displayed:
105105

106106
The information message begins with the {+product+} Rule ID that generated the
107107
popup. In the previous example, the Rule ID is ``MAPoco1001``, indicating
108-
the POCO is valid.
108+
the POCO is valid. To learn more about this rule, see the
109+
:ref:`mongodb-analyzer-rules` guide.
55.8 KB
Loading
47.9 KB
Loading
59.7 KB
Loading
49.2 KB
Loading
94.5 KB
Loading
56.1 KB
Loading
103 KB
Loading

source/index.txt

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
Installation </install>
1414
/analyze-code
15+
/rules
1516
Configuration </configuration>
1617
/known-issues
1718
FAQ </faq>
@@ -22,40 +23,48 @@
2223
Overview
2324
--------
2425

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

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

33-
The {+product+} can analyze the following groups of {+driver-short+} expressions and
34-
classes:
33+
.. note:: Roslyn Analyzer
34+
35+
The {+product+} is a Roslyn Analyzer. To learn more about Roslyn Analyzers, see
36+
`Overview of Source Code Analysis <https://docs.microsoft.com/en-us/visualstudio/code-quality/roslyn-analyzers-overview?view=vs-2022>`__
37+
from Microsoft.
38+
39+
Supported Analysis
40+
~~~~~~~~~~~~~~~~~~
41+
42+
The {+product+} can analyze the following groups of {+driver-short+}
43+
expressions and classes:
3544

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

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

43-
- :ref:`Install the extension <mongodb-analyzer-install>`
44-
- :ref:`Analyze your code <mongodb-analyzer-analyze-code>`
45-
- :ref:`Configure the extension <mongodb-analyzer-configuration>`
52+
View the following guides to learn how to install and
53+
configure the {+product+} and how to use its features:
54+
55+
- :ref:`Installation <mongodb-analyzer-install>`
56+
- :ref:`Analyze Your Code <mongodb-analyzer-analyze-code>`
57+
- :ref:`Rules and Message Content <mongodb-analyzer-rules>`
58+
- :ref:`Configuration <mongodb-analyzer-configuration>`
4659

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

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

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

55-
For further support, see the :ref:`Issues and Help <mongodb-analyzer-issues-and-help>` page.
56-
57-
.. note:: Roslyn Analyzer
58-
59-
The {+product+} is a Roslyn Analyzer. To learn more about Roslyn Analyzers, see
60-
`Overview of Source Code Analysis <https://docs.microsoft.com/en-us/visualstudio/code-quality/roslyn-analyzers-overview?view=vs-2022>`__
61-
from Microsoft.
69+
For further support, see the :ref:`Issues and Help
70+
<mongodb-analyzer-issues-and-help>` page.

0 commit comments

Comments
 (0)