-
Notifications
You must be signed in to change notification settings - Fork 42
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 an overview of local.php for mautic 4 documentation #138
base: 4.x
Are you sure you want to change the base?
Conversation
Was able to help with the proofreading. Would love for the community to support in additional review for merging. If I can support in any way, feel free to HMU. |
Hi folks, Thanks for the PR! 🚀 Please take note of the failing tests - you have some RST markup failures like the headings. I will make a review to suggest improvements. |
I have no idea why but the PR review ended up at beetofly#1 😕 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't fixed every instance but hopefully this makes sense.
Some key things to consider:
Please use VSCode with the extensions, it should automatically lint for you and tell you the issues as you type. The main things are using brackets - use hyphens instead - and the links.
Please use RST linking to link to other sections/pages. Every title is unique so you can just the ref: role to link to them enclosed in backticks. Always try to link to the appropriate sub-section of the page using the relevant heading rather than just linking to the page, it's more useful for the reader.
Shout if you need any help!
Here's some useful resources: https://sublime-and-sphinx-guide.readthedocs.io/ which might be helpful along the way!
This pull request has been mentioned on Mautic Community Forums. There might be relevant details there: https://forum.mautic.org/t/configuring-memcache-or-redis-in-local-php/27267/2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey there, sorry for the delay in getting back to you - just one small suggestion on the case of the heading then we are good to go!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey there, sorry for the delay in getting back to you - just one small suggestion on the case of the heading then we are good to go!
Yes, it is better in lower case. Co-authored-by: Ruth Cheesley <[email protected]>
Hey @beetofly thanks so much for your patience with this! If you'd like to do a PR for the equivalent on 5.x then please use the 5.x branch! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Vale warnings can be ignored.
@favour-chibueze / @fakela anything we can do about the table width here? |
we
we might need to add a custom CSS for this |
Yes, we would need to add a CSS styling |
I think we already had table styling for this repo, could you take a lookies? Maybe it's not implemented correctly? |
@fakela @favour-chibueze could you fix the table styling here possibly? We'd like to add another part to this to explain environment variables. |
Add an overview of local.php file based on a mautic 4.4.6 instance
We at Leuchtfeuer created this local.php overview as a proposal for the user documentation of mautic 4.
The impulse to create such an overview for mautic 4 was made by Sven Döring.
Sven Döring offered and did already the first proofreading/review.
Thanks a lot for that to Sven Döring.
So this PR Version has passed one time proofreading/review, but needs more by the community.
We would be glad, if somebody can do the additional review, so that it maybe could be part of the user documentation for mautic 4.