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.

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

Add docs on extending configuration #96

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

dennisameling
Copy link
Member

@dennisameling dennisameling commented Dec 4, 2022

Closes #60
Needs #86

Defining the parameters in the Plugin's config file ensures that it always exists.

To add config options to the Configuration section, you will need to add an :ref:`Event Listener<Event listeners>`, a config :ref:`form type<Forms>`, and a specific view (TODO).
Copy link
Member Author

Choose a reason for hiding this comment

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

This needs #86 to be merged first, so we can link to the Form Type section from here.

Copy link
Member

Choose a reason for hiding this comment

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

That PR is merged now so should be good to go with this comment :)

Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

A few suggestions :)

docs/components/config.rst Outdated Show resolved Hide resolved
docs/components/config.rst Outdated Show resolved Hide resolved
Defining the parameters in the Plugin's config file ensures that it always exists.

To add config options to the Configuration section, you need to add an :ref:`Event Listener<Event listeners>`, a config :ref:`form type<Forms>`, and a specific view (TODO).
Copy link
Member Author

Choose a reason for hiding this comment

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

Looks like we don't have the docs on MVC in the new docs yet: https://developer.mautic.org/#mvc

Have just created a separate issue for that: #99

Copy link
Member

Choose a reason for hiding this comment

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

OK great - so we are just pending the MVC section for now with this part.

@dennisameling dennisameling marked this pull request as draft December 6, 2022 17:19
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.

Write documentation for Configuration component
2 participants