Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOCSP-39641 Standardize product name #59

Merged
merged 2 commits into from
May 21, 2024
Merged

DOCSP-39641 Standardize product name #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1691ca
update product name
jordan-smith721 May 20, 2024
b0f7799
build errors
jordan-smith721 May 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
==============================
MongoDB Analyzer Documentation
==============================

This repository contains documentation for the MongoDB Analyzer.
=================================
{+product+} Documentation

Check failure on line 2 in README.rst

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.Titles] '{+product+} Documentation' should be in AP title case.

Raw Output:
{"message": "[MongoDB.Titles] '{+product+} Documentation' should be in AP title case.", "location": {"path": "README.rst", "range": {"start": {"line": 2, "column": 1}}}, "severity": "ERROR"}
=================================

This repository contains documentation for the {+product+}.

File JIRA Tickets
-----------------
Expand Down
2 changes: 1 addition & 1 deletion snooty.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/analyze-code.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The {+product+} can analyze expressions created with the following patterns:
- :ref:`Plain Old CLR/Class Objects (POCOs) <mongodb-analyzer-analyze-pocos>`

Use the {+product+} From the Command Line
----------------------------------------------
-------------------------------------------------

To run the {+product+} from the command line and save your results to a
:github:`SARIF </microsoft/sarif-tutorials/blob/main/docs/1-Introduction.md>`
Expand Down
4 changes: 2 additions & 2 deletions source/configuration.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _mongodb-analyzer-configuration:

==============================
=================================
Configure the {+product+}
==============================
=================================

.. contents:: On this page
:local:
Expand Down
10 changes: 5 additions & 5 deletions source/faq.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Frequently Asked Questions
:class: singlecol

Does the {+product+} support JetBrains Rider?
--------------------------------------------------
-----------------------------------------------------

No, the {+product+} does not officially support JetBrains Rider.

Expand All @@ -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.

Expand All @@ -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+}.
Expand All @@ -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.

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion source/includes/telemetry-data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion source/install.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _mongodb-analyzer-install:

Install the {+product+}
----------------------------
-------------------------------

.. contents:: On this page
:local:
Expand Down
Loading