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

Config form notes interface #232

Open
wants to merge 3 commits into
base: 5.x
Choose a base branch
from
Open

Config form notes interface #232

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8684d22
Update integrations.rst
shinde-rahul Nov 19, 2024
0c1e531
Update integrations.rst
shinde-rahul Nov 19, 2024
ed47192
Update docs/components/integrations.rst
shinde-rahul Dec 3, 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
11 changes: 11 additions & 0 deletions docs/components/integrations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,3 +128,14 @@

1. :ref:`Register the Integration<components/integrations_builder:Register the Integration as a builder>` as an Integration that provides a custom builder.
2. Configure what featured builders the Integration supports (Mautic currently supports 'Email' and 'Landing Page' builders).

.. vale off

Config Form Notes Interface
***************************

.. vale on

The interface, :code:`\Mautic\IntegrationsBundle\Integration\Interfaces\ConfigFormNotesInterface`, provides a way to put notes, either info or warning, on the plugin configuration form.

Check failure on line 139 in docs/components/integrations.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'PUT' instead of 'put'.

Raw Output:
{"message": "[Vale.Terms] Use 'PUT' instead of 'put'.", "location": {"path": "docs/components/integrations.rst", "range": {"start": {"line": 139, "column": 118}}}, "severity": "ERROR"}

Check failure on line 139 in docs/components/integrations.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Plugin' instead of 'plugin'.

Raw Output:
{"message": "[Vale.Terms] Use 'Plugin' instead of 'plugin'.", "location": {"path": "docs/components/integrations.rst", "range": {"start": {"line": 139, "column": 160}}}, "severity": "ERROR"}

Check warning on line 139 in docs/components/integrations.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 'Plugin' instead of 'plugin'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Plugin' instead of 'plugin'.", "location": {"path": "docs/components/integrations.rst", "range": {"start": {"line": 139, "column": 160}}}, "severity": "INFO"}

Check warning on line 139 in docs/components/integrations.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 'Form' instead of 'form'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Form' instead of 'form'.", "location": {"path": "docs/components/integrations.rst", "range": {"start": {"line": 139, "column": 181}}}, "severity": "INFO"}

Read more about to how-tos :ref:`Integration Configuration Form Notes<components/integrations_configuration_form_notes:Integration configuration form notes>`

Check warning on line 141 in docs/components/integrations.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 'Components' instead of 'components'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Components' instead of 'components'.", "location": {"path": "docs/components/integrations.rst", "range": {"start": {"line": 141, "column": 71}}}, "severity": "INFO"}

Check warning on line 141 in docs/components/integrations.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 'Form' instead of 'form'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Form' instead of 'form'.", "location": {"path": "docs/components/integrations.rst", "range": {"start": {"line": 141, "column": 109}}}, "severity": "INFO"}
Loading