Giter Club home page Giter Club logo

developer-documentation-new's Introduction

Documentation Status

All Contributors

Open in Gitpod

Mautic developer documentation (new)

This repository hosts the new developer documentation for Mautic on the Read the Docs platform. Whenever a PR is merged, changes are deployed immediately to https://mautic-developer.readthedocs.io/

If you're looking for the legacy developer documentation, please go to https://developer.mautic.org/ or the GitHub repository.

Migration of developer docs to 'Read the Docs'

The aim is to move all aspects of the developer documentation to Read the Docs (with the exception of the REST API documentation). In the video below, @dennisameling explains how the documentation is currently structured and briefly touches upon current limitations.

For more background, the end goal, and if you want to help, please see this issue. Thanks in advance.

Link to YouTube video with explanation of the current developer documentation structure

Adding a code sample

Code samples get downloaded from GitHub to ensure that they're always up to date. If you want to add a new code sample, follow these two steps:

  1. Create a file in docs/code_samples/ and add a permalink in there. Look at other files in that directory for examples. URLs should always start with https://raw.githubusercontent.com/... to ensure that Sphinx can download the file correctly.
  2. In any documentation file, add a literalinclude block to include the code, like so:
.. The link to this file is defined in docs/code_samples/helloworld_entity_world.py 
.. literalinclude:: ../code_samples_downloaded/Entity_World.php
    :language: php

Tip: downloaded files get cached in docs/code_samples_downloaded to prevent overloading GitHub with download requests. If you change the URL to a file, simply remove the cached file from docs/code_samples_downloaded and Sphinx automatically re-downloads it.

Build documentation locally

The following provides instructions for how to build docs locally for visualization without pushing to the remote:

  1. Install Python 3 for your OS if not already installed
  2. Install Sphinx pip install sphinx
  3. Install sphinx-rtd-theme pip install sphinx-rtd-theme
  4. CD into the docs directory cd [path to this repo]/docs
  5. Run make html
  6. This generates HTML in docs/build/html. Setup a web server with the web root as docs/build/html or open docs/build/html/index.html in a browser.

Troubleshooting

If the build isn't working for some reason, here's some tips:

  • Try running the make html command in the terminal: cd docs && make html. This command normally provides a lot of additional context.
  • If the preview isn't working, click the esbonio section in the bottom right corner of the VS Code window. That rebuilds the docs and previews, and tells you if something is wrong.

Vale

Before pushing, run Vale and address suggestions and errors as applicable.

  1. Install vale
  2. vale .

PhpStorm & PyCharm file watcher

You can automatically build changes to .rst files using a file watcher.

  1. Go to Preferences -> Tools -> File Watchers -> + button -> custom
  2. Configure the watcher as presented in the screenshot

Screen Shot 2021-10-06 at 15 52 06

Style guide

Please consult Mautic's style-guide before contributing to the documentation. Some rules get enforced through Vale.

As a quick reference, here's the list of headings Mautic uses:

H1: ############
H2: ****************
H3: ============
H4: ----------------
H5: ~~~~~~~~~~~~

Converting markdown to reStructuredText

Mautic's documentation uses reStructuredText, or .rst files. Luckily, there's converters available that help you convert .md to .rst files. Here's an example of m2r - this converter also converts tables into list-table directives properly.

pip install m2r
# This creates a new file with the .rst extension:
m2r my_markdown_file.md

Contributors โœจ

Thanks goes to these wonderful people (emoji key):

Robert Parker
Robert Parker

๐Ÿ“–
Rahul Shinde
Rahul Shinde

๐Ÿ“–
Dennis Ameling
Dennis Ameling

๐Ÿ“– ๐Ÿ‘€

This project follows the all-contributors specification. Contributions of any kind welcome.

developer-documentation-new's People

Contributors

alanhartless avatar allcontributors[bot] avatar dennisameling avatar dependabot[bot] avatar escopecz avatar fakela avatar lenonleite avatar luk4s avatar mabumusa1 avatar nick-vanpraet avatar rcheesley avatar roboparker avatar shinde-rahul avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

developer-documentation-new's Issues

Fix RST syntax errors

Currently there are some errors which need fixing:

NOTE: Might need to exclude the anchor links from the link checker: https://github.com/mautic/developer-documentation-new/blob/5.x/docs/conf.py#L80 - see the user docs for example: https://github.com/mautic/user-documentation/blob/5.x/docs/conf.py#L69

Title level inconsistent: Headings not in correct order (H1 > H2 > H3 > H4 > H5)

duplicate object description of xxxx, other instance in yyyyy: Headings must always be unique - here we're using the same heading in more than one place. There's a way around it, I believe, using a Custom Anchor.

undefined label: 'xxxx': something wonky with a heading

/home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/emails.rst:448: CRITICAL: Title level inconsistent:

Email components


/home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/emails.rst:462: CRITICAL: Title level inconsistent:

Preparing Mautic for testing


/home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/emails.rst:470: CRITICAL: Title level inconsistent:

Testing Email transport


/home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/emails.rst:477: CRITICAL: Title level inconsistent:

Testing the connection

/home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/emails.rst:488: CRITICAL: Title level inconsistent:

Sending a sample Email

/home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/emails.rst:497: CRITICAL: Title level inconsistent:

Upload an Asset

/home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/emails.rst:506: CRITICAL: Title level inconsistent:

Create a template Email

/home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/emails.rst:521: CRITICAL: Title level inconsistent:

Create a Segment Email

/home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/emails.rst:534: CRITICAL: Title level inconsistent:

Send an individual Email

/home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/emails.rst:539: CRITICAL: Title level inconsistent:

Send a Report Email

/home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/emails.rst:544: CRITICAL: Title level inconsistent:

Other Email features

/home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/emails.rst:549: CRITICAL: Title level inconsistent:

Testing transport callback


/home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/points.rst:22: WARNING: duplicate object description of getActions, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/campaigns.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/development-environment/getting_started.rst:2: WARNING: duplicate label development environment, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/development-environment/environments.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/rest_api/campaigns.rst:3: WARNING: duplicate label campaigns, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/campaigns.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/rest_api/categories.rst:3: WARNING: duplicate label categories, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/categories.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/rest_api/contacts.rst:2: WARNING: duplicate label contacts, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/contacts.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/rest_api/reports.rst:2: WARNING: duplicate label reports, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/components/reports.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/company_post_save.rst:9: WARNING: duplicate label event type, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/company_post_delete.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/company_post_save.rst:16: WARNING: duplicate label event properties, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/company_post_delete.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/email_on_open.rst:11: WARNING: duplicate label event type, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/company_post_save.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/email_on_open.rst:18: WARNING: duplicate label event properties, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/company_post_save.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/email_on_send.rst:9: WARNING: duplicate label event type, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/email_on_open.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/email_on_send.rst:16: WARNING: duplicate label event properties, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/email_on_open.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/form_on_submit.rst:9: WARNING: duplicate label event type, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/email_on_send.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/form_on_submit.rst:16: WARNING: duplicate label event properties, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/email_on_send.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_channel_subscription_changed.rst:9: WARNING: duplicate label event type, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/form_on_submit.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_channel_subscription_changed.rst:16: WARNING: duplicate label event properties, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/form_on_submit.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_company_change.rst:9: WARNING: duplicate label event type, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_channel_subscription_changed.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_company_change.rst:16: WARNING: duplicate label event properties, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_channel_subscription_changed.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_points_change.rst:9: WARNING: duplicate label event type, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_company_change.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_points_change.rst:16: WARNING: duplicate label event properties, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_company_change.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_post_delete.rst:9: WARNING: duplicate label event type, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_points_change.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_post_delete.rst:16: WARNING: duplicate label event properties, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_points_change.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_post_save_new.rst:9: WARNING: duplicate label event type, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_post_delete.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_post_save_new.rst:16: WARNING: duplicate label event properties, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_post_delete.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_post_save_update.rst:9: WARNING: duplicate label event type, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_post_save_new.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_post_save_update.rst:16: WARNING: duplicate label event properties, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_post_save_new.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/page_on_hit.rst:9: WARNING: duplicate label event type, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_post_save_update.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/page_on_hit.rst:16: WARNING: duplicate label event properties, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/lead_post_save_update.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/sms_on_send.rst:9: WARNING: duplicate label event type, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/page_on_hit.rst
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/sms_on_send.rst:16: WARNING: duplicate label event properties, other instance in /home/runner/work/developer-documentation-new/developer-documentation-new/docs/webhooks/events/page_on_hit.rst

/home/runner/work/developer-documentation-new/developer-documentation-new/docs/plugins/config.rst:348: WARNING: undefined label: 'roles and permissions'
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/plugins/config.rst:516: WARNING: undefined label: 'roles and permissions'
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/plugins/config.rst:617: WARNING: undefined label: 'text message transports'
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/plugins/config.rst:620: WARNING: undefined label: 'text message transports'
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/plugins/config.rst:638: WARNING: undefined label: 'roles and permissions'
/home/runner/work/developer-documentation-new/developer-documentation-new/docs/plugins/config.rst:665: WARNING: undefined label: 'sync notification handlers'

(development-environment/how_to_install_with_ddev: line 9) broken https://ddev.readthedocs.io/en/stable/#installation - Anchor 'installation' not found

(plugins/autowiring: line 105) broken https://github.com/mautic/mautic/blob/HEAD/app/bundles/CoreBundle/DependencyInjection/MauticCoreExtension.php#L12 - Anchor 'L12' not found

(components/emails: line 26) broken https://kb.mautic.org/knowledgebase/emails/how-does-mautic-do-ab-testing - 404 Client Error: Not Found for url: https://kb.mautic.org/knowledgebase/emails/how-does-mautic-do-ab-testing

( plugins/config: line 501) broken https://symfony.com/doc/current/controller/service.html#how-to-define-controllers-as-services - Anchor 'how-to-define-controllers-as-services' not found

Remove auto-merge GitHub actions

Early on we used an auto-merge job which would push approved PRs directly to the development branch, but we aren't using that any more and we don't want to do auto-merging because we need to ensure the correct branch is used and that any related PRs are merged first in mautic/mautic, for example.

So I think we should probably look to remove the workflow files and just manually approve when we're ready.

Clicking menu links in the preview on Gitpod creates invalid URLs

I don't know if this is something that you can fix but when reviewing the Marketplace PR on Gitpod I noticed that the URLs in the preview browser are broken. They look like this:

https://vscode-remote+aquamarine-002dtyrannosaurus-002d6irm5bne-002ews-002deu18-002egitpod-002eio.vscode-resource.gitpod.io/workspace/developer-documentation-new/build/html/marketplace/getting_started.html

Would be nice if you could use the UI to check the menu is working but may be a limitation of the platform maybe?

Implement the Vale linter

We should implement the Vale linter here as we have it set up in the end-user docs. Maybe there is some way to keep the vocabulary file syncrhonised between the two repositories if there are changes to our definitions?

Gitpod integration is not allowing preview of pages

When I open in Gitpod I am prompted to install a whole bunch of things, and then if I try to preview any of the files I get the following (tested with this link: https://gitpod.io/#https://github.com/mautic/developer-documentation-new/pull/14)

Cannot show preview page.
Description:
Cannot generate preview page.

Possible causes are,

Python is not installed properly.
Sphinx is not installed properly (if preview uses "conf.py").
Wrong value is set on "restructuredtext.sphinxBuildPath".
A wrong "conf.py" file is selected.
DocUtils is not installed properly (if preview uses docutils).
Detailed error message
Error
Command failed: "/home/gitpod/.pyenv/versions/3.8.12/bin/python" -m sphinx -b html . "/workspace/developer-documentation-new/build/html"

Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/home/gitpod/.pyenv/versions/3.8.12/lib/python3.8/site-packages/sphinx/config.py", line 329, in eval_config_file
    exec(code, namespace)
  File "/workspace/developer-documentation-new/docs/conf.py", line 18, in 
    import sphinx_rtd_theme
ModuleNotFoundError: No module named 'sphinx_rtd_theme'


Error: Command failed: "/home/gitpod/.pyenv/versions/3.8.12/bin/python" -m sphinx -b html . "/workspace/developer-documentation-new/build/html"

Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/home/gitpod/.pyenv/versions/3.8.12/lib/python3.8/site-packages/sphinx/config.py", line 329, in eval_config_file
    exec(code, namespace)
  File "/workspace/developer-documentation-new/docs/conf.py", line 18, in 
    import sphinx_rtd_theme
ModuleNotFoundError: No module named 'sphinx_rtd_theme'


	at ChildProcess.exithandler (child_process.js:308:12)
	at ChildProcess.emit (events.js:315:20)
	at maybeClose (internal/child_process.js:1048:16)
	at Process.ChildProcess._handle.onexit (internal/child_process.js:288:5)


Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/home/gitpod/.pyenv/versions/3.8.12/lib/python3.8/site-packages/sphinx/config.py", line 329, in eval_config_file
    exec(code, namespace)
  File "/workspace/developer-documentation-new/docs/conf.py", line 18, in 
    import sphinx_rtd_theme
ModuleNotFoundError: No module named 'sphinx_rtd_theme'

More Information
Diagnostics information has been written to OUTPUT | reStructuredText panel.

The troubleshooting guide can be found at

https://docs.restructuredtext.net/articles/troubleshooting.html

Port documentation on REST API

TIP: use m2r to convert .md files from the old developer docs into .rst. When using this converter, most of these docs shouldn't take more than ~20 mins to migrate over.

Here's an example of m2r - this converter also converts tables into list-table directives properly.

pip install m2r
# This creates a new file with the .rst extension:
m2r my_markdown_file.md

Goals of the new developer documentation

We aim to replace the current developer documentation at https://developer.mautic.org/ with a new one on Read the Docs. These docs are to be put at https://mautic-developer.readthedocs.io.

Background

  • Large parts of the documentation were written in the Mautic 2 era, resulting in many external links and code examples being out of date
  • While we have automated deployments in place, we have to maintain the server at https://developer.mautic.org ourselves (OS/security updates, etc.). This adds a maintenance burden to the infrastructure team
  • The current documentation is basically one immense page, leading to a long initial load time and non-ideal user experience
  • Mautic supports multiple major versions at the same time. When Mautic 4 is released, Mautic 3 will still be supported through bug fixes for a while. The current platform, Slate, doesn't have built-in support for multiple versions of documentation. Read the Docs, however, supports this out of the box.
  • Some developers feel lost when they start working on or with Mautic. It'd be ideal if we could take developers a bit more by the hand. We can do so by providing them with a working development environment without too much effort. Recently, Mautic has added a built-in DDEV configuration, which allows developers to simply run ddev start and have DDEV set up everything for them automatically (PHP, database, MailHog, Mautic installation, etc.)

The goal

By moving to Read the Docs, we hope to solve the pain points above and provide developers with a smooth experience when they work on or with Mautic.

The strategy

In order to reach our goal, we need to split up the work into various chunks. If you would like to write a certain section - or a part of it - please leave a comment in this issue, so that we know who's working on what. Your help is greatly appreciated!

Sections that need to be moved over:

  • Plugins
  • Marketplace (as part of the Plugins section)
  • Cache Bundle (as part of the Plugins section)
  • Themes
  • Webhooks
  • MauticJS API
  • REST API (to be discussed later*)

* = Ideally, we'd like to have auto-generated REST API docs, so that they're always up to date. An attempt was made to make that happen, but at the moment of writing this doesn't seem worth the effort as Mautic next-gen will have auto-generated REST API docs right from the start.

Fix remaining Vale warnings/errors in codebase

Needs #21 to be merged first.

When running vale ., there's quite some errors and warnings showing up, but at least the errors should be easy to fix!

Click for details
% vale .   

 .vscode/welcome.md
 1:52  error       Don't use exclamation points    Google.Exclamation 
                   in text.                                           
 3:1   warning     Try to avoid using              Google.We          
                   first-person plural like 'We'.                     
 4:1   suggestion  Use parentheses judiciously.    Google.Parens      
 5:62  suggestion  Spell out 'LIVE', if it's       Google.Acronyms    
                   unfamiliar to the audience.                        
 9:13  error       Don't use exclamation points    Google.Exclamation 
                   in text.                                           


 README.md
 3:12    error       Did you really mean 'Gitpod'?   Vale.Spelling      
 5:34    suggestion  Use parentheses judiciously.    Google.Parens      
 7:126   suggestion  In general, use active voice    Google.Passive     
                     instead of passive voice ('is                      
                     merged').                                          
 7:145   suggestion  In general, use active voice    Google.Passive     
                     instead of passive voice ('are                     
                     deployed').                                        
 9:23    warning     Try to avoid using              Google.We          
                     first-person plural like                           
                     'our'.                                             
 11:4    warning     'Migration of developer docs    Google.Headings    
                     to Read the Docs' should use                       
                     sentence-style capitalization.                     
 13:1    warning     Try to avoid using              Google.We          
                     first-person plural like 'We'.                     
 13:76   suggestion  Use parentheses judiciously.    Google.Parens      
 13:103  suggestion  Spell out 'REST', if it's       Google.Acronyms    
                     unfamiliar to the audience.                        
 14:164  warning     Try to avoid using              Google.We          
                     first-person plural like 'we'.                     
 16:22   warning     Try to avoid using              Google.We          
                     first-person plural like                           
                     'our'.                                             
 16:47   warning     Try to avoid using              Google.We          
                     first-person plural like 'us'.                     
 16:83   warning     Use 'select' instead of         Google.WordList    
                     'check'.                                           
 16:154  error       Don't use exclamation points    Google.Exclamation 
                     in text.                                           
 22:4    suggestion  Spell out 'RST', if it's        Google.Acronyms    
                     unfamiliar to the audience.                        
 30:23   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Theme'                        
                     instead of 'theme'.                                
 33:9    warning     Avoid using 'will'.             Google.Will        
 33:42   error       Use 'HTML' instead of 'html'.   Vale.Terms         
 33:99   error       Use 'HTML' instead of 'html'.   Vale.Terms         
 33:123  error       Use 'HTML' instead of 'html'.   Vale.Terms         
 33:134  error       Use 'HTML' instead of 'html'.   Vale.Terms         
 40:5    warning     'PhpStorm/PyCharm File          Google.Headings    
                     Watcher' should use                                
                     sentence-style capitalization.                     
 41:40   error       Did you really mean 'rst'?      Vale.Spelling      


 docs/components/channels.rst
 5:19  suggestion  Is this referring to a          Mautic.FeatureList 
                   Mautic feature? If so, use                         
                   'Integration' instead of                           
                   'integration'.                                     


 docs/components/emails.rst
 8:1   error  Use 'Todo' instead of 'todo'.  Vale.Terms 
 13:1  error  Use 'Todo' instead of 'todo'.  Vale.Terms 


 docs/components/integrations.rst
 18:1  warning  'Integration Builders'          Google.Headings 
                should use sentence-style                       
                capitalization.                                 


 docs/components/security.rst
 13:8  warning  Use 'single sign-on' instead    Google.WordList 
                of 'sign-on'.                                   


 docs/components/sms.rst
 4:1  warning  'Text Message transports'       Google.Headings 
               should use sentence-style                       
               capitalization.                                 


 docs/components/tracking_script.rst
 5:5  warning  ': I' should be in lowercase.  Google.Colons 
 7:5  warning  ': U' should be in lowercase.  Google.Colons 


 docs/components/translator.rst
 11:19   suggestion  Spell out 'INI', if it's        Google.Acronyms 
                     unfamiliar to the audience.                     
 17:74   warning     Try to avoid using              Google.We       
                     first-person plural like 'US'.                  
 26:43   suggestion  Spell out 'INI', if it's        Google.Acronyms 
                     unfamiliar to the audience.                     
 31:69   suggestion  In general, use active voice    Google.Passive  
                     instead of passive voice ('are                  
                     defined').                                      
 48:345  suggestion  In general, use active voice    Google.Passive  
                     instead of passive voice ('are                  
                     wrapped').                                      
 57:1    warning     'Using the Translator service'  Google.Headings 
                     should use sentence-style                       
                     capitalization.                                 


 docs/form_hooks/response_hooks.rst
 75:74  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'Landing                       
                    Page' instead of 'page'.                           


 docs/form_hooks/getting_started.rst
 1:1    warning     'Getting started with           Google.Headings    
                    Form hooks' should use                             
                    sentence-style capitalization.                     
 8:161  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'Forms'                        
                    instead of 'forms'.                                


 docs/marketplace/allowlist_what_and_why.rst
 2:1     error       Use 'allowlist' instead of      Vale.Terms          
                     'Allowlist'.                                        
 2:12    suggestion  Feel free to use 'what's'       Google.Contractions 
                     instead of 'what is'.                               
 5:61    suggestion  Is this referring to a Mautic   Mautic.FeatureList  
                     feature? If so, use 'Plugin'                        
                     instead of 'plugin'.                                
 6:393   suggestion  Is this referring to a Mautic   Mautic.FeatureList  
                     feature? If so, use 'Users'                         
                     instead of 'users'.                                 
 20:167  suggestion  Is this referring to a Mautic   Mautic.FeatureList  
                     feature? If so, use 'Email'                         
                     instead of 'email'.                                 
 26:88   suggestion  Is this referring to a Mautic   Mautic.FeatureList  
                     feature? If so, use 'Plugins'                       
                     instead of 'plugins'.                               


 docs/marketplace/best_practices.rst
 5:15    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Plugins'                      
                     instead of 'plugins'.                              
 7:96    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Users'                        
                     instead of 'users'.                                
 8:67    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Users'                        
                     instead of 'users'.                                
 8:85    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Report'                       
                     instead of 'report'.                               
 10:108  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Users'                        
                     instead of 'users'.                                
 11:127  error       Use 'PUT' instead of 'put'.     Vale.Terms         
 11:192  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Users'                        
                     instead of 'users'.                                
 13:70   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Plugin'                       
                     instead of 'plugin'.                               


 docs/marketplace/getting_started.rst
 5:73   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'User'                         
                    instead of 'user'.                                 
 7:85   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'Plugins'                      
                    instead of 'plugins'.                              
 7:105  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'Plugins'                      
                    instead of 'plugins'.                              
 8:65   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'Plugins'                      
                    instead of 'plugins'.                              
 10:1   error       Use 'Todo' instead of 'TODO'.   Vale.Terms         
 10:6   suggestion  Use parentheses judiciously.    Google.Parens      
 17:46  error       Use 'Todo' instead of 'TODO'.   Vale.Terms         
 17:51  suggestion  Use parentheses judiciously.    Google.Parens      
 17:52  suggestion  Spell out 'LINK', if it's       Google.Acronyms    
                    unfamiliar to the audience.                        


 docs/marketplace/listing.rst
 12:128  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Users'                        
                     instead of 'users'.                                
 16:23   error       Use 'Composer' instead of       Vale.Terms         
                     'composer'.                                        
 21:19   error       Use 'Composer' instead of       Vale.Terms         
                     'composer'.                                        
 41:56   error       Use 'Composer' instead of       Vale.Terms         
                     'composer'.                                        
 45:191  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Users'                        
                     instead of 'users'.                                
 52:127  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Landing                       
                     Page' instead of 'page'.                           
 57:10   error       Use 'Composer' instead of       Vale.Terms         
                     'composer'.                                        
 62:314  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Landing                       
                     Page' instead of 'page'.                           
 69:33   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Plugin'                       
                     instead of 'plugin'.                               


 docs/plugins/getting_started.rst
 1:1  warning  'Getting started with Plugins'  Google.Headings 
               should use sentence-style                       
               capitalization.                                 


 docs/plugins/installation.rst
 6:132  warning     Avoid using 'will'.             Google.Will    
 6:149  suggestion  In general, use active voice    Google.Passive 
                    instead of passive voice ('be                  
                    used').                                        


 docs/themes/forms.rst
 1:13    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Forms'                        
                     instead of 'forms'.                                
 11:295  suggestion  Spell out 'PHP', if it's        Google.Acronyms    
                     unfamiliar to the audience.                        


 docs/plugins/translations.rst
 1:13  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                   feature? If so, use 'Plugins'                      
                   instead of 'plugins'.                              
 6:38  warning     Try to avoid using              Google.We          
                   first-person plural like 'US'.                     


 docs/plugins/mautic_vs_symfony.rst
 1:1     warning     'Deviations from standard       Google.Headings    
                     Symfony Framework' should use                      
                     sentence-style capitalization.                     
 24:51   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Assets'                       
                     instead of 'assets'.                               
 62:159  error       Use 'FALSE' instead of          Vale.Terms         
                     'false'.                                           
 68:1    warning     'Firewalls and User access      Google.Headings    
                     management' should use                             
                     sentence-style capitalization.                     
 70:44   warning     Use 'firewall rules' instead    Google.WordList    
                     of 'firewalls'.                                    
 70:124  warning     Use 'firewall rules' instead    Google.WordList    
                     of 'firewalls'.                                    
 78:1    warning     'Custom Translator' should use  Google.Headings    
                     sentence-style capitalization.                     
 80:70   suggestion  Is this referring to a          Mautic.FeatureList 
                     Mautic feature? If so,                             
                     use 'Component' instead of                         
                     'component'.                                       
 80:178  warning     Try to avoid using              Google.We          
                     first-person plural like 'US'.                     


 docs/themes/grapesjs.rst
 1:1    warning     'GrapesJS Builder' should use   Google.Headings    
                    sentence-style capitalization.                     
 4:181  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'Emails'                       
                    instead of 'emails'.                               


 docs/themes/system.rst
 6:37  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                   feature? If so, use 'Landing                       
                   Page' instead of 'page'.                           


 docs/themes/getting_started.rst
 1:1      warning     'Getting started with Themes'   Google.Headings    
                      should use sentence-style                          
                      capitalization.                                    
 6:43     suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Landing                       
                      Pages' instead of 'pages'.                         
 6:77     suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Form'                         
                      instead of 'form'.                                 
 6:140    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Landing                       
                      Page' instead of 'page'.                           
 13:27    suggestion  Is this referring to a          Mautic.FeatureList 
                      Mautic feature? If so, use                         
                      'Components' instead of                            
                      'components'.                                      
 54:19    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Theme'                        
                      instead of 'theme'.                                
 56:18    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Theme'                        
                      instead of 'theme'.                                
 58:18    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Theme'                        
                      instead of 'theme'.                                
 58:47    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Landing                       
                      Page' instead of 'Page'.                           
 67:1     warning     'html/message.html.twig'        Google.Headings    
                      should use sentence-style                          
                      capitalization.                                    
 67:1     error       Use 'HTML' instead of 'html'.   Vale.Terms         
 67:14    error       Use 'HTML' instead of 'html'.   Vale.Terms         
 70:57    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Contact'                      
                      instead of 'Lead'.                                 
 70:107   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Emails'                       
                      instead of 'emails'.                               
 74:59    suggestion  In general, use active voice    Google.Passive     
                      instead of passive voice                           
                      ('been unsubscribed').                             
 74:76    warning     In general, don't use an        Google.Ellipses    
                      ellipsis.                                          
 76:97    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Form'                         
                      instead of 'form'.                                 
 92:1     error       Use 'HTML' instead of 'html'.   Vale.Terms         
 92:1     warning     'html/email.html.twig'          Google.Headings    
                      should use sentence-style                          
                      capitalization.                                    
 92:6     suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Email'                        
                      instead of 'email'.                                
 92:12    error       Use 'HTML' instead of 'html'.   Vale.Terms         
 95:98    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Email'                        
                      instead of 'email'.                                
 136:1    error       Use 'HTML' instead of 'html'.   Vale.Terms         
 136:1    warning     'html/page.html.twig'           Google.Headings    
                      should use sentence-style                          
                      capitalization.                                    
 136:6    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Landing                       
                      Page' instead of 'page'.                           
 160:1    warning     'html/form.html.twig'           Google.Headings    
                      should use sentence-style                          
                      capitalization.                                    
 160:1    error       Use 'HTML' instead of 'html'.   Vale.Terms         
 160:6    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Form'                         
                      instead of 'form'.                                 
 163:42   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Form'                         
                      instead of 'form'.                                 
 163:51   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Form'                         
                      instead of 'form'.                                 
 163:162  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Landing                       
                      Page' instead of 'page'.                           
 192:151  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Form'                         
                      instead of 'form'.                                 
 192:175  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Form'                         
                      instead of 'form'.                                 


 docs/plugins/config.rst
 1:1      error       Use 'config' instead of         Vale.Terms         
                      'Config'.                                          
 95:9     warning     Use 'firewall rules' instead    Google.WordList    
                      of 'firewalls'.                                    
 98:15    warning     Use 'firewall rules' instead    Google.WordList    
                      of 'firewalls'.                                    
 119:117  warning     Use 'firewall rules' instead    Google.WordList    
                      of 'firewalls'.                                    
 121:70   warning     Use 'firewall rules' instead    Google.WordList    
                      of 'firewalls'.                                    
 134:9    suggestion  In general, use active voice    Google.Passive     
                      instead of passive voice ('Is                      
                      required').                                        
 156:152  suggestion  In general, use active voice    Google.Passive     
                      instead of passive voice ('is                      
                      ignored').                                         
 179:36   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Landing                       
                      Page' instead of 'page'.                           
 179:61   suggestion  In general, use active voice    Google.Passive     
                      instead of passive voice ('be                      
                      used').                                            
 326:9    suggestion  In general, use active voice    Google.Passive     
                      instead of passive voice ('Is                      
                      required').                                        
 417:71   error       Use 'TRUE' instead of 'true'.   Vale.Terms         
 488:25   warning     Avoid using 'will'.             Google.Will        
 530:9    suggestion  In general, use active voice    Google.Passive     
                      instead of passive voice ('Is                      
                      required').                                        
 552:139  suggestion  In general, use active voice    Google.Passive     
                      instead of passive voice ('is                      
                      set').                                             
 572:50   suggestion  In general, use active voice    Google.Passive     
                      instead of passive voice ('is                      
                      instantiated').                                    
 620:42   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                      feature? If so, use 'Webhooks'                     
                      instead of 'webhooks'.                             
 703:222  suggestion  Use semicolons judiciously.     Google.Semicolons  
 703:256  suggestion  Use semicolons judiciously.     Google.Semicolons  
 703:297  suggestion  Use semicolons judiciously.     Google.Semicolons  


 docs/themes/legacy.rst
 1:1     warning     'Legacy Builder' should use     Google.Headings    
                     sentence-style capitalization.                     
 4:79    suggestion  In general, use active voice    Google.Passive     
                     instead of passive voice ('be                      
                     deleted').                                         
 42:27   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'User'                         
                     instead of 'user'.                                 
 42:77   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Email'                        
                     instead of 'email'.                                
 42:163  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'User'                         
                     instead of 'user'.                                 
 52:18   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'User'                         
                     instead of 'user'.                                 
 52:139  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'User'                         
                     instead of 'user'.                                 
 59:65   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'User'                         
                     instead of 'user'.                                 
 81:95   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Theme'                        
                     instead of 'theme'.                                
 81:147  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Users'                        
                     instead of 'users'.                                


 docs/webhooks/events/company_post_delete.rst
 27:69  warning     Avoid using 'will'.             Google.Will     
 30:41  suggestion  Spell out 'ISO', if it's        Google.Acronyms 
                    unfamiliar to the audience.                     


 docs/webhooks/events/company_post_save.rst
 26:41   suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 44:16   error       Use 'TRUE' instead of 'true'.   Vale.Terms          
 47:31   suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('was                      
                     created').                                          
 47:46   suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 56:52   suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 56:82   suggestion  Feel free to use 'hasn't'       Google.Contractions 
                     instead of 'has not'.                               
 56:90   suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been modified').                                  
 95:38   suggestion  Use parentheses judiciously.    Google.Parens       
 98:17   suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('are                      
                     grouped').                                          
 98:370  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     set').                                              


 docs/webhooks/events/form_on_submit.rst
 27:41   suggestion  Spell out 'ISO', if it's        Google.Acronyms 
                     unfamiliar to the audience.                     
 57:46   suggestion  Spell out 'ISO', if it's        Google.Acronyms 
                     unfamiliar to the audience.                     
 66:124  suggestion  In general, use active voice    Google.Passive  
                     instead of passive voice ('was                  
                     embedded').                                     


 docs/webhooks/events/lead_channel_subscription_changed.rst
 1:9    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'Channel'                      
                    instead of 'channel'.                              
 4:43   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'Channel'                      
                    instead of 'channel'.                              
 28:13  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'Channel'                      
                    instead of 'channel'.                              
 28:33  suggestion  In general, use active voice    Google.Passive     
                    instead of passive voice ('was                     
                    unsubscribed').                                    
 31:52  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'Channel'                      
                    instead of 'channel'.                              
 34:47  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'Channel'                      
                    instead of 'channel'.                              
 37:41  suggestion  Spell out 'ISO', if it's        Google.Acronyms    
                    unfamiliar to the audience.                        


 docs/webhooks/events/lead_company_change.rst
 1:1    warning     'Contact Company subscription   Google.Headings 
                    change event' should use                        
                    sentence-style capitalization.                  
 24:33  suggestion  In general, use active voice    Google.Passive  
                    instead of passive voice ('was                  
                    added').                                        
 33:41  suggestion  Spell out 'ISO', if it's        Google.Acronyms 
                    unfamiliar to the audience.                     


 docs/webhooks/events/email_on_send.rst
 33:37   error       Did you really mean             Vale.Spelling       
                     'templated'?                                        
 45:138  suggestion  Is this referring to a Mautic   Mautic.FeatureList  
                     feature? If so, use 'Email'                         
                     instead of 'email'.                                 
 45:156  warning     Avoid using 'will'.             Google.Will         
 51:41   suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 72:29   suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('was                      
                     created').                                          
 72:44   suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 81:50   suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 81:80   suggestion  Feel free to use 'hasn't'       Google.Contractions 
                     instead of 'has not'.                               
 81:88   suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been modified').                                  
 84:70   suggestion  Feel free to use 'hasn't'       Google.Contractions 
                     instead of 'has not'.                               
 84:78   suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been modified').                                  
 111:9   error       Use 'TRUE' instead of 'True'.   Vale.Terms          
 111:42  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('be                       
                     set').                                              
 117:28  suggestion  Is this referring to a Mautic   Mautic.FeatureList  
                     feature? If so, use 'Email'                         
                     instead of 'email'.                                 
 120:20  suggestion  Is this referring to a Mautic   Mautic.FeatureList  
                     feature? If so, use 'Theme'                         
                     instead of 'theme'.                                 
 123:62  suggestion  Use parentheses judiciously.    Google.Parens       
 126:43  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been opened').                                    
 129:43  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been sent').                                      
 132:43  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been edited').                                    
 138:28  suggestion  Spell out 'UTM', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 138:28  error       Use 'utm' instead of 'UTM'.     Vale.Terms          
 138:65  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('are                      
                     supported').                                        
 141:36  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('be                       
                     published').                                        
 141:52  suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 144:36  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('be                       
                     considered').                                       
 144:65  suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 150:89  suggestion  Feel free to use 'isn't'        Google.Contractions 
                     instead of 'is not'.                                
 153:43  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been sent').                                      
 156:43  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been read').                                      
 213:68  suggestion  Feel free to use 'hasn't'       Google.Contractions 
                     instead of 'has not'.                               
 213:76  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been modified').                                  
 243:43  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been edited').                                    
 249:31  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('was                      
                     uploaded').                                         
 249:68  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     hosted').                                           
 264:45  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been downloaded').                                
 306:87  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been modified').                                  
 330:30  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     related').                                          
 350:5   warning     'Unsubscribe Form properties'   Google.Headings     
                     should use sentence-style                           
                     capitalization.                                     
 381:64  suggestion  Feel free to use 'hasn't'       Google.Contractions 
                     instead of 'has not'.                               
 381:72  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been modified').                                  
 384:35  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('be                       
                     published').                                        
 384:51  suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 387:35  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('be                       
                     considered').                                       
 387:64  suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 393:55  suggestion  Is this referring to a Mautic   Mautic.FeatureList  
                     feature? If so, use 'Landing                        
                     Page' instead of 'page'.                            
 399:53  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been submitted').                                 
 402:31  suggestion  Is this referring to a Mautic   Mautic.FeatureList  
                     feature? If so, use 'User'                          
                     instead of 'user'.                                  
 405:61  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     disabled').                                         
 405:64  warning     Use 'turn off' or 'off'         Google.WordList     
                     instead of 'disabled'.                              
 411:62  suggestion  Is this referring to a Mautic   Mautic.FeatureList  
                     feature? If so, use 'Landing                        
                     Pages' instead of 'pages'.                          
 414:39  suggestion  Is this referring to a Mautic   Mautic.FeatureList  
                     feature? If so, use 'Form'                          
                     instead of 'form'.                                  
 422:5   warning     'Unsubscribe Form field         Google.Headings     
                     properties' should use                              
                     sentence-style capitalization.                      
 456:41  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     required').                                         
 485:5   warning     'Unsubscribe Form action        Google.Headings     
                     properties' should use                              
                     sentence-style capitalization.                      


 docs/webhooks/events/lead_points_change.rst
 1:9    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'Points'                       
                    instead of 'points'.                               
 3:44   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                    feature? If so, use 'Points'                       
                    instead of 'points'.                               
 36:41  suggestion  Spell out 'ISO', if it's        Google.Acronyms    
                    unfamiliar to the audience.                        


 docs/webhooks/events/lead_post_delete.rst
 27:69  warning     Avoid using 'will'.             Google.Will     
 30:41  suggestion  Spell out 'ISO', if it's        Google.Acronyms 
                    unfamiliar to the audience.                     


 docs/webhooks/events/lead_post_save_new.rst
 28:41   suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 46:16   error       Use 'TRUE' instead of 'true'.   Vale.Terms          
 49:31   suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('was                      
                     created').                                          
 49:46   suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 58:31   suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('was                      
                     identified').                                       
 58:49   suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 61:52   suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 61:82   suggestion  Feel free to use 'hasn't'       Google.Contractions 
                     instead of 'has not'.                               
 61:90   suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice                            
                     ('been modified').                                  
 79:17   suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('are                      
                     grouped').                                          
 79:370  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     set').                                              
 82:50   suggestion  Spell out 'ISO', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 82:80   suggestion  Feel free to use 'hasn't'       Google.Contractions 
                     instead of 'has not'.                               
 85:66   suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     assigned').                                         
 105:5   warning     'Custom Field properties'       Google.Headings     
                     should use sentence-style                           
                     capitalization.                                     
 133:51  warning     Avoid using 'will'.             Google.Will         
 165:4   warning     'IP Address properties'         Google.Headings     
                     should use sentence-style                           
                     capitalization.                                     
 187:27  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     located').                                          
 190:29  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     located').                                          
 193:31  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     located').                                          
 196:35  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     located').                                          
 199:36  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     located').                                          
 202:9   suggestion  Spell out 'ISP', if it's        Google.Acronyms     
                     unfamiliar to the audience.                         
 205:29  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     assigned').                                         
 247:51  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     unsubscribed').                                     
 247:89  suggestion  In general, use active voice    Google.Passive      
                     instead of passive voice ('is                       
                     bounced').                                          


 docs/webhooks/events/sms_on_send.rst
 33:41  suggestion  Spell out 'ISO', if it's        Google.Acronyms 
                    unfamiliar to the audience.                     


 docs/webhooks/events/page_on_hit.rst
 1:1     suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Landing                       
                     Page' instead of 'Page'.                           
 27:41   suggestion  Spell out 'ISO', if it's        Google.Acronyms    
                     unfamiliar to the audience.                        
 29:5    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Landing                       
                     Page' instead of 'Page'.                           
 42:19   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Landing                       
                     Page' instead of 'Page'.                           
 45:41   suggestion  Spell out 'ISO', if it's        Google.Acronyms    
                     unfamiliar to the audience.                        
 57:107  suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Landing                       
                     Page' instead of 'page'.                           
 69:9    suggestion  Spell out 'ISP', if it's        Google.Acronyms    
                     unfamiliar to the audience.                        
 75:32   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Landing                       
                     Page' instead of 'Page'.                           
 78:26   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Landing                       
                     Page' instead of 'Page'.                           
 81:21   suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Landing                       
                     Page' instead of 'Page'.                           
 84:9    suggestion  Is this referring to a Mautic   Mautic.FeatureList 
                     feature? If so, use 'Landing                       
                     Page' instead of 'Page'.                           
 115:5   warning     'Landing Page basic             Google.Headings    
                     properties' should use                             
                     sentence-style capitalization.                     


 docs/webhooks/example_scripts.rst
 67:1  warning  'Node.js' should use            Google.Headings 
                sentence-style capitalization.                  


 docs/webhooks/getting_started.rst
 1:22     suggestion  Is this referring to a Mautic   Mautic.FeatureList  
                      feature? If so, use 'Webhooks'                      
                      instead of 'webhooks'.                              
 4:164    suggestion  In general, use active voice    Google.Passive      
                      instead of passive voice ('be                       
                      sent').                                             
 6:131    warning     Avoid using 'will'.             Google.Will         
 38:70    suggestion  In general, use active voice    Google.Passive      
                      instead of passive voice ('be                       
                      used').                                             
 40:52    suggestion  Use parentheses judiciously.    Google.Parens       
 40:53    suggestion  Spell out 'PMS', if it's        Google.Acronyms     
                      unfamiliar to the audience.                         
 49:8     suggestion  Spell out 'PMS', if it's        Google.Acronyms     
                      unfamiliar to the audience.                         
 59:8     suggestion  Spell out 'PMS', if it's        Google.Acronyms     
                      unfamiliar to the audience.                         
 61:1     warning     'Configuring Webhooks'          Google.Headings     
                      should use sentence-style                           
                      capitalization.                                     
 82:1     warning     'Creating a Webhook'            Google.Headings     
                      should use sentence-style                           
                      capitalization.                                     
 84:134   suggestion  In general, use active voice    Google.Passive      
                      instead of passive voice ('is                       
                      exposed').                                          
 88:168   suggestion  Feel free to use 'that's'       Google.Contractions 
                      instead of 'that is'.                               
 92:1     warning     'Testing a Webhook' should use  Google.Headings     
                      sentence-style capitalization.                      
 97:100   suggestion  Is this referring to a Mautic   Mautic.FeatureList  
                      feature? If so, use 'Form'                          
                      instead of 'form'.                                  
 103:1    warning     'Securing a Webhook'            Google.Headings     
                      should use sentence-style                           
                      capitalization.                                     
 106:37   suggestion  Spell out 'HMAC', if it's       Google.Acronyms     
                      unfamiliar to the audience.                         
 106:343  suggestion  Spell out 'HMAC', if it's       Google.Acronyms     
                      unfamiliar to the audience.                         
 110:63   suggestion  In general, use active voice    Google.Passive      
                      instead of passive voice ('be                       
                      ignored').                                          

โœ– 33 errors, 58 warnings and 209 suggestions in 62 files.

Update references to Symfony 4 documentation

I noticed we have a bunch of Symfony links which are going to 4.x documentation - we should check these and update where appropriate to use the 5 docs:

(components/forms_advanced: line 84) redirect https://symfony.com/doc/4.4/form/validation_groups.html - permanently to https://symfony.com/doc/4.x/form/validation_groups.html

(components/forms_advanced: line 19) redirect https://symfony.com/doc/4.4/form/create_custom_field_type.html#defining-the-form-type - permanently to https://symfony.com/doc/4.x/form/create_custom_field_type.html#defining-the-form-type

(development-environment/environments: line 4) redirect https://symfony.com/doc/4.4/index.html - permanently to https://symfony.com/doc/4.x/index.html

(components/forms_advanced: line 67) redirect https://symfony.com/doc/4.4/form/dynamic_form_modification.html - permanently to https://symfony.com/doc/4.x/form/dynamic_form_modification.html

(components/forms_advanced: line 4) redirect https://symfony.com/doc/4.4/forms.html#creating-form-classes - permanently to https://symfony.com/doc/4.x/forms.html#creating-form-classes

(components/forms_advanced: line 74) redirect https://symfony.com/doc/4.4/forms.html#validating-forms - permanently to https://symfony.com/doc/4.x/forms.html#validating-forms

(components/forms_advanced: line 157) redirect https://symfony.com/doc/4.4/reference/constraints.html - permanently to https://symfony.com/doc/4.x/reference/constraints.html

( plugins/config: line 498) redirect https://symfony.com/doc/4.4/reference/dic_tags.html#console-command - permanently to https://symfony.com/doc/4.x/reference/dic_tags.html#console-command

(components/campaigns: line 126) redirect https://symfony.com/doc/4.4/reference/dic_tags.html#form-type - permanently to https://symfony.com/doc/4.x/reference/dic_tags.html#form-type

( plugins/config: line 510) redirect https://symfony.com/doc/4.4/reference/dic_tags.html#templating-helper - permanently to https://symfony.com/doc/4.x/reference/dic_tags.html#templating-helper

( plugins/config: line 504) redirect https://symfony.com/doc/4.4/reference/dic_tags.html#kernel-event-subscriber - permanently to https://symfony.com/doc/4.x/reference/dic_tags.html#kernel-event-subscriber

( plugins/config: line 592) redirect https://symfony.com/doc/4.4/service_container/configurators.html - permanently to https://symfony.com/doc/4.x/service_container/configurators.html

( plugins/config: line 568) redirect https://symfony.com/doc/4.4/service_container/factories.html - permanently to https://symfony.com/doc/4.x/service_container/factories.html

( plugins/config: line 588) redirect https://symfony.com/doc/4.4/service_container/definitions.html#requiring-files - permanently to https://symfony.com/doc/4.x/service_container/definitions.html#requiring-files

( plugins/config: line 576) redirect https://symfony.com/doc/4.4/service_container/service_decoration.html - permanently to https://symfony.com/doc/4.x/service_container/service_decoration.html

( plugins/config: line 584) redirect https://symfony.com/doc/4.4/service_container/synthetic_services.html - permanently to https://symfony.com/doc/4.x/service_container/synthetic_services.html

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.