Documentation for component integration.

[shinde-rahul]

This fixes, #62
This PR adds,

• Documentation for plugin configuration.
• Documentation for ConfigFormNotesInterface

[RCheesley]

Looks like you have a broken link to fix on this one @shinde-rahul - the build linter is failing.

The repo https://github.com/mautic/plugin-integrations does not exist.

There are also a lot of RST errors where duplicated headings are being used, and Vale errors too. Happy to walk thought it with you!

[RCheesley]

Thanks for getting started with bringing this over @shinde-rahul, awesome job!

There are a few things to bear in mind with the docs which we need to write up:

• Links need to be created with the external links extension markup
• We don't use Camel Case in headings - only capitalise within the heading if you are referring to a feature of Mautic (eg Contacts, Companies, Plugins etc)
• Always use example.com as the domain name when referring to a URL - with Mautic I think we also append /api for the API but please do check that.

You might find it easier to review the PR in GitPod if you are not getting the feedback about the RST / Vale issues in your IDE. Give me a shout if you need any help with any of this!

[RCheesley]

Is this the same as #76? Or something new?

[shinde-rahul]

Is this the same as #76? Or something new?

@RCheesley, #76 does not hold changes for the ConfigFormNotesInterface as this new feature is introduced in 5.x.
I was not sure, so I raised for both versions.

[RCheesley]

@shinde-rahul could you review/update the outstanding unresolved conversations please? Thanks!

[RCheesley]

Hi @shinde-rahul do you think you can get this finished up?

[shinde-rahul]

@RCheesley, this is stuck with either

• When I change form to Form, the vale check for Google.Headings yields a warning see here
  OR
• For the form, vale yields this Mautic.FeatureList

How to fix this, I need help here.

[RCheesley]

Where is the problem in the code?

You can usually wrap it with this:

.. vale off

Text here

.. vale on

[shinde-rahul]

@RCheesley, thanks! I forgot about the vale on/off. This is now ready for review.

[RCheesley]

This looks good to me, would value a developer review of the content before we merge. Thanks for the PR @shinde-rahul 🚀

Here's how to review with GitPod for folks who might not have done that before on the new docs: https://watch.screencastify.com/v/Ttn3Vr7MQbHkefkYUeJe

Shout if you need any help!

[escopecz]

Looks good. Thanks Rahul!