Open
Conversation
RCheesley
reviewed
Feb 28, 2023
RCheesley
left a comment
RCheesley
left a comment
There was a problem hiding this comment.
I haven't corrected every single instance, but this should give you enough of a head start to implement the correct RST formatting / linking.
Here's some useful resources: https://sublime-and-sphinx-guide.readthedocs.io/ which might be helpful along the way!
| @@ -0,0 +1,554 @@ | |||
| Local.php fields overview | |||
| ######### | |||
There was a problem hiding this comment.
This needs to be the full underline length of the title.
| Local.php fields overview | ||
| ######### | ||
|
|
||
| Most but not all Mautic configuration can be done from the user interface. |
There was a problem hiding this comment.
You need to use active tense here! Also need to capitalise User Interface.
Maybe:
Suggested change
| Most but not all Mautic configuration can be done from the user interface. | |
| Most but not all Mautic configuration is managed in the User Interface. |
| ######### | ||
|
|
||
| Most but not all Mautic configuration can be done from the user interface. | ||
| Either way, the settings live in the local.php file. |
There was a problem hiding this comment.
Let's make it clear that we're talking about a filename.
Suggested change
| Either way, the settings live in the local.php file. | |
| Either way, the settings live in the ``local.php`` file. |
|
|
||
| Most but not all Mautic configuration can be done from the user interface. | ||
| Either way, the settings live in the local.php file. | ||
| Here is the list of the local.php parameters for mautic 4.4.6: |
There was a problem hiding this comment.
Suggested change
| Here is the list of the local.php parameters for mautic 4.4.6: | |
| Here are the ``local.php`` parameters for Mautic 4.4.6: |
| - Value | ||
| - Info | ||
| * - allowed_extensions | ||
| - default: An indexed array with the values csv, doc, docx, epub, gif, jpg, jpeg, mpg, mpeg, mp3, odt, odp, ods, pdf, png, ppt, pptx, tif, tiff, txt, xls, xlsx, wav |
There was a problem hiding this comment.
Let's put these into code markup.
Suggested change
| - default: An indexed array with the values csv, doc, docx, epub, gif, jpg, jpeg, mpg, mpeg, mp3, odt, odp, ods, pdf, png, ppt, pptx, tif, tiff, txt, xls, xlsx, wav | |
| - default: an indexed array with the values ``csv``, ``doc``, ``docx``, ``epub``, ``gif``, ``jpg``, ``jpeg``, ``mpg``, ``mpeg``, ``mp3``, ``odt``, ``odp``, ``ods``, ``pdf``, ``png``, ``ppt``, ``pptx``, ``tif``, ``tiff``, ``txt``, ``xls``, ``xlsx``, ``wav`` |
| - The "Enable HTTP basic auth?" parameter from the Mautic configuration settings (API settings): https://mautic-documentation.readthedocs.io/en/latest/configuration/settings.html | ||
| * - api_enabled | ||
| - default: 0 (for 'No') | ||
| - The "API enabled?" parameter from the Mautic configuration settings (API settings): https://mautic-documentation.readthedocs.io/en/latest/configuration/settings.html |
There was a problem hiding this comment.
Suggested change
| - The "API enabled?" parameter from the Mautic configuration settings (API settings): https://mautic-documentation.readthedocs.io/en/latest/configuration/settings.html | |
| - The "API enabled?" parameter from the Mautic configuration API settings: :ref:`API settings` |
| - default: 0 (for 'No') | ||
| - The "API enabled?" parameter from the Mautic configuration settings (API settings): https://mautic-documentation.readthedocs.io/en/latest/configuration/settings.html | ||
| * - api_oauth2_access_token_lifetime | ||
| - default: 60 (minutes) |
There was a problem hiding this comment.
Suggested change
| - default: 60 (minutes) | |
| - default: 60 - minutes |
| - The "API enabled?" parameter from the Mautic configuration settings (API settings): https://mautic-documentation.readthedocs.io/en/latest/configuration/settings.html | ||
| * - api_oauth2_access_token_lifetime | ||
| - default: 60 (minutes) | ||
| - The "Access token lifetime (in minutes)" parameter from the Mautic configuration settings (API settings): https://mautic-documentation.readthedocs.io/en/latest/configuration/settings.html |
There was a problem hiding this comment.
Suggested change
| - The "Access token lifetime (in minutes)" parameter from the Mautic configuration settings (API settings): https://mautic-documentation.readthedocs.io/en/latest/configuration/settings.html | |
| - The "Access token lifetime in minutes" parameter from the Mautic configuration API settings: :ref:`API settings` |
| - default: 60 (minutes) | ||
| - The "Access token lifetime (in minutes)" parameter from the Mautic configuration settings (API settings): https://mautic-documentation.readthedocs.io/en/latest/configuration/settings.html | ||
| * - api_oauth2_refresh_token_lifetime | ||
| - default: 14 (days) |
There was a problem hiding this comment.
Suggested change
| - default: 14 (days) | |
| - default: 14 days |
| * - allowed_extensions | ||
| - default: An indexed array with the values csv, doc, docx, epub, gif, jpg, jpeg, mpg, mpeg, mp3, odt, odp, ods, pdf, png, ppt, pptx, tif, tiff, txt, xls, xlsx, wav | ||
| - The "Allowed file extensions" parameter from the Mautic configuration settings (Theme settings): https://mautic-documentation.readthedocs.io/en/latest/configuration/settings.html | ||
| * - anonymize_ip |
There was a problem hiding this comment.
Let's code-wrap these values so it's clear that it's a setting variable.
Suggested change
| * - anonymize_ip | |
| * - ``anonymize_ip`` |
…slations-index-pot--main_pt_BR Translate 'docs/docs_translations/index.pot' in 'pt_BR'
…ions-pot--main_pt_BR
…slations-translations-pot--main_pt_BR Translate 'docs/docs_translations/translations.pot' in 'pt_BR'
…slations-contacts-pot--main_pt_BR Translate 'docs/docs_translations/contacts.pot' in 'pt_BR'
100% translated for the source file 'docs/docs_translations/categories.pot' on the 'pt_BR' language.
100% translated for the source file 'docs/docs_translations/plugins.pot' on the 'pt_BR' language.
…slations-plugins-pot--main_pt_BR Translate 'docs/docs_translations/plugins.pot' in 'pt_BR'
…es-pot--main_pt_BR
…slations-categories-pot--main_pt_BR Translate 'docs/docs_translations/categories.pot' in 'pt_BR'
100% translated for the source file 'docs/docs_translations/authentication.pot' on the 'pt_BR' language.
100% translated for the source file 'docs/docs_translations/dashboard.pot' on the 'pt_BR' language.
100% translated for the source file 'docs/docs_translations/overview.pot' on the 'pt_BR' language.
…slations-authentication-pot--main_pt_BR Translate 'docs/docs_translations/authentication.pot' in 'pt_BR'
…slations-overview-pot--main_pt_BR Translate 'docs/docs_translations/overview.pot' in 'pt_BR'
…d-pot--main_pt_BR
…slations-dashboard-pot--main_pt_BR Translate 'docs/docs_translations/dashboard.pot' in 'pt_BR'
…slations-stages-pot--main_pt_BR Translate 'docs/docs_translations/stages.pot' in 'pt_BR'
100% translated for the source file 'docs/docs_translations/search.pot' on the 'pt_BR' language.
100% translated for the source file 'docs/docs_translations/queue.pot' on the 'pt_BR' language.
…slations-queue-pot--main_pt_BR Translate 'docs/docs_translations/queue.pot' in 'pt_BR'
Fix build fail
Merge Main to 4.x
Remove update command from 4.x docs
Fix: Read the Docs, build and prose failed in branch `4.x`, and add DDEV configuration
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
12 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.