Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history 
Co-authored-by: Ruth Cheesley <[email protected]>
  • Loading branch information
@RitaOC @RCheesley
RitaOC and RCheesley authored Nov 11, 2024
1 parent 9f21d50 commit f9f8ff3
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/about/about.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
About Mautic
############

If you've discovered our handbook, you're likely interested in learning more about the Mautic community. But what exactly is Mautic?
If you've discovered this handbook, you're likely interested in learning more about the Mautic community. But what exactly is Mautic?

This section has some basic information in case you haven't come across Mautic, or our community, before.
This section has some basic information in case you haven't come across Mautic, or the Mautic community, before.
8 changes: 4 additions & 4 deletions docs/about/how_can_i_try_mautic.rst
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
How can I try Mautic?
#####################
How to try Mautic?
##################

Mautic is available to download for free [:xref:`Download Mautic`], allowing you to explore its full capabilities without restrictions when you host it yourself.
Mautic is available to download for free, just head over to the website where you can :xref:`Download Mautic`, allowing you to explore its full capabilities without restrictions when you host it yourself.

For optimal performance, we recommend hosting Mautic on a Virtual Private Server (VPS) rather than shared hosting, particularly if you intend to use it in a production setting on lower end hosting which often have limited resources, which may impact Mautic's efficiency and performance.
For optimal performance, it's recommended to host Mautic on a Virtual Private Server (VPS) rather than shared hosting, particularly if you intend to use it in a production setting on lower end hosting which often have limited resources, which may impact Mautic's efficiency and performance.

Check warning on line 6 in docs/about/how_can_i_try_mautic.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/about/how_can_i_try_mautic.rst", "range": {"start": {"line": 6, "column": 86}}}, "severity": "INFO"}

For further information on setup and hosting recommendations, visit the :xref:`Mautic Documentation`.
4 changes: 2 additions & 2 deletions docs/about/how_is_mautic_used.rst
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
How is Mautic Used?
How is Mautic used?

Check warning on line 1 in docs/about/how_is_mautic_used.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Contractions] Feel free to use 'how's' instead of 'How is'.

Raw Output:
{"message": "[Google.Contractions] Feel free to use 'how's' instead of 'How is'.", "location": {"path": "docs/about/how_is_mautic_used.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "INFO"}
###################

Mautic is a powerful and flexible Marketing Automation platform that supports a wide range of marketing and communication activities. Its versatility allows organizations to customize Mautic for various use cases:
Expand All @@ -7,7 +7,7 @@ Mautic is a powerful and flexible Marketing Automation platform that supports a

* **Email Marketing Campaigns** Create, manage, and track dynamic email campaigns, including segmentation and personalized messaging.

Check warning on line 8 in docs/about/how_is_mautic_used.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.", "location": {"path": "docs/about/how_is_mautic_used.rst", "range": {"start": {"line": 8, "column": 67}}}, "severity": "INFO"}

Check warning on line 8 in docs/about/how_is_mautic_used.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Campaigns' instead of 'campaigns'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Campaigns' instead of 'campaigns'.", "location": {"path": "docs/about/how_is_mautic_used.rst", "range": {"start": {"line": 8, "column": 73}}}, "severity": "INFO"}

* **Activity Tracking**: Mautic allows tracking of user activities across web resources, providing valuable insights for targeted marketing.
* **Activity Tracking** Mautic allows tracking of user activities across web resources, providing valuable insights for targeted marketing.

Check warning on line 10 in docs/about/how_is_mautic_used.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'User' instead of 'user'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'User' instead of 'user'.", "location": {"path": "docs/about/how_is_mautic_used.rst", "range": {"start": {"line": 10, "column": 51}}}, "severity": "INFO"}

* **Mass Communication Management** Mautic can coordinate large-scale, multi-channel communications, ideal for governments, public services, and other organizations.

Check warning on line 12 in docs/about/how_is_mautic_used.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Channel' instead of 'channel'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Channel' instead of 'channel'.", "location": {"path": "docs/about/how_is_mautic_used.rst", "range": {"start": {"line": 12, "column": 78}}}, "severity": "INFO"}

Expand Down

0 comments on commit f9f8ff3

Please sign in to comment.