Skip to content

docs: Port "Config parameters" service page to 7.2#582

Open
promptless-for-oss wants to merge 3 commits into
mautic:7.2from
Promptless:promptless/docs-issue-367-config-parameters-7.2
Open

docs: Port "Config parameters" service page to 7.2#582
promptless-for-oss wants to merge 3 commits into
mautic:7.2from
Promptless:promptless/docs-issue-367-config-parameters-7.2

Conversation

@promptless-for-oss

Copy link
Copy Markdown
Contributor

Open this suggestion in Promptless to view citations and reasoning process

Ports the legacy Config parameters guide into plugin_services/parameters.rst on the 7.2 base branch, converting the legacy Markdown to RST and modernizing it to inject CoreParametersHelper and use get()/has()/all(). Mirrors the reviewed 7.1 port. Resolves docs issue #367.

Trigger Events


Tip: Enable auto-create PR in your Configuration to review suggestions directly in GitHub 🤖

.. vale on

Use ``Mautic\CoreBundle\Helper\CoreParametersHelper`` to read Mautic's configuration parameters, including any your Plugin declares. Inject the helper into your service:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ported from the legacy _plugin_services_parameters.md include, which documented reading the helloworld_api_enabled config parameter via mautic.helper.core_parameters (Mautic\CoreBundle\Helper\CoreParametersHelper). Modernized to inject CoreParametersHelper and call get()/has()/all() per Mautic 7 service conventions, matching issue #366's guidance to update content while porting.

Source: https://raw.githubusercontent.com/mautic/developer-documentation/main/source/includes/_plugin_services_parameters.md

Comment thread docs/plugin_services/parameters.rst Outdated
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Thanks for the review, @adiati98! I've addressed the Google.Passive warning.

In docs/plugin_services/parameters.rst, the flagged phrase "to confirm whether a parameter is set" was rewritten in active voice — has() now reads "to confirm whether a parameter exists".

Vale is clean on the changed lines. The update is pushed to this PR.

Comment thread docs/plugin_services/parameters.rst Outdated
Addresses @adiati98's review: the legacy placeholder note (wrapped in
.. vale off/.. vale on) is obsolete now that the page has real content.
@promptless-for-oss

Copy link
Copy Markdown
Contributor Author

Done, @adiati98 — I removed the placeholder note admonition (and its now-unneeded .. vale off / .. vale on wrappers) from docs/plugin_services/parameters.rst. The page now goes straight from the title into the CoreParametersHelper content.

Vale is clean on the changed content. The update is pushed to this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants