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.

Sign up for GitHub

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

Convert About section to RST #245

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Convert About section to RST #245

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
db0bfb1
About Section
RitaOC Oct 29, 2024
f4193a0
Worked on how to try mautic conversion
RitaOC Oct 29, 2024
9814450
about overview
RitaOC Oct 29, 2024
d14a919
Update the heading in how_can_i_try_mautic.rst
RitaOC Oct 31, 2024
eb29eba
Update the heading for how_is_mautic_used.rst
RitaOC Oct 31, 2024
e4cfa1d
Update heading in about overview
RitaOC Nov 4, 2024
9f21d50
Merge branch 'main' into Rita_covert_abt
RCheesley Nov 5, 2024
f9f8ff3
Apply suggestions from code review
RitaOC Nov 11, 2024
fcad2df
Nesting all into 1 about page
RitaOC Nov 19, 2024
a4c4587
Delete docs/about/how_can_i_try_mautic.rst
RitaOC Nov 19, 2024
95ed29c
Delete docs/about/how_is_mautic_used.rst
RitaOC Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/about/about.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
About Mautic
############

If you've discovered our handbook, you're likely interested in learning more about the Mautic community. But what exactly is Mautic?
RitaOC marked this conversation as resolved.
Show resolved Hide resolved

This section has some basic information in case you haven't come across Mautic, or our community, before.
RitaOC marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 8 additions & 0 deletions docs/about/how_can_i_try_mautic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
How can I try Mautic?

Check warning on line 1 in docs/about/how_can_i_try_mautic.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.FirstPerson] Avoid first-person pronouns such as ' I '.

Raw Output:
{"message": "[Google.FirstPerson] Avoid first-person pronouns such as ' I '.", "location": {"path": "docs/about/how_can_i_try_mautic.rst", "range": {"start": {"line": 1, "column": 8}}}, "severity": "WARNING"}
RitaOC marked this conversation as resolved.
Show resolved Hide resolved
#####################
RitaOC marked this conversation as resolved.
Show resolved Hide resolved

Mautic is available to download for free [:xref:`Download Mautic`], allowing you to explore its full capabilities without restrictions when you host it yourself.
RitaOC marked this conversation as resolved.
Show resolved Hide resolved

For optimal performance, we recommend hosting Mautic on a Virtual Private Server (VPS) rather than shared hosting, particularly if you intend to use it in a production setting on lower end hosting which often have limited resources, which may impact Mautic's efficiency and performance.

Check warning on line 6 in docs/about/how_can_i_try_mautic.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'we'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "docs/about/how_can_i_try_mautic.rst", "range": {"start": {"line": 6, "column": 26}}}, "severity": "WARNING"}

Check warning on line 6 in docs/about/how_can_i_try_mautic.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.

Raw Output:
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/about/how_can_i_try_mautic.rst", "range": {"start": {"line": 6, "column": 82}}}, "severity": "INFO"}
RitaOC marked this conversation as resolved.
Show resolved Hide resolved

For further information on setup and hosting recommendations, visit the :xref:`Mautic Documentation`.
16 changes: 16 additions & 0 deletions docs/about/how_is_mautic_used.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
How is Mautic Used?

Check warning on line 1 in docs/about/how_is_mautic_used.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Headings] 'How is Mautic Used?' should use sentence-style capitalization.

Raw Output:
{"message": "[Google.Headings] 'How is Mautic Used?' should use sentence-style capitalization.", "location": {"path": "docs/about/how_is_mautic_used.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "WARNING"}

Check warning on line 1 in docs/about/how_is_mautic_used.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Contractions] Feel free to use 'how's' instead of 'How is'.

Raw Output:
{"message": "[Google.Contractions] Feel free to use 'how's' instead of 'How is'.", "location": {"path": "docs/about/how_is_mautic_used.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "INFO"}
RitaOC marked this conversation as resolved.
Show resolved Hide resolved
###################

Mautic is a powerful and flexible Marketing Automation platform that supports a wide range of marketing and communication activities. Its versatility allows organizations to customize Mautic for various use cases:

* **Omni-channel Marketing Automation** Mautic enables seamless marketing across multiple channels, ensuring consistent engagement across email, social media, and more.

Check warning on line 6 in docs/about/how_is_mautic_used.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Channel' instead of 'channel'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Channel' instead of 'channel'.", "location": {"path": "docs/about/how_is_mautic_used.rst", "range": {"start": {"line": 6, "column": 10}}}, "severity": "INFO"}

Check warning on line 6 in docs/about/how_is_mautic_used.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Channels' instead of 'channels'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Channels' instead of 'channels'.", "location": {"path": "docs/about/how_is_mautic_used.rst", "range": {"start": {"line": 6, "column": 91}}}, "severity": "INFO"}

Check warning on line 6 in docs/about/how_is_mautic_used.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.", "location": {"path": "docs/about/how_is_mautic_used.rst", "range": {"start": {"line": 6, "column": 139}}}, "severity": "INFO"}

* **Email Marketing Campaigns** Create, manage, and track dynamic email campaigns, including segmentation and personalized messaging.

Check warning on line 8 in docs/about/how_is_mautic_used.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Email' instead of 'email'.", "location": {"path": "docs/about/how_is_mautic_used.rst", "range": {"start": {"line": 8, "column": 67}}}, "severity": "INFO"}

Check warning on line 8 in docs/about/how_is_mautic_used.rst

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Campaigns' instead of 'campaigns'.

Raw Output:
{"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Campaigns' instead of 'campaigns'.", "location": {"path": "docs/about/how_is_mautic_used.rst", "range": {"start": {"line": 8, "column": 73}}}, "severity": "INFO"}

* **Activity Tracking**: Mautic allows tracking of user activities across web resources, providing valuable insights for targeted marketing.
RitaOC marked this conversation as resolved.
Show resolved Hide resolved

* **Mass Communication Management** Mautic can coordinate large-scale, multi-channel communications, ideal for governments, public services, and other organizations.

* **Landing Page Creation** Design custom landing pages optimized for specific campaigns, promotions, or targeted messages.

* **Lead Nurturing** Build and automate lead nurturing workflows to guide prospects through the sales funnel, ensuring personalized engagement.
3 changes: 3 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ The vision is that it grows over time as the teams and governance structure evol
:caption: About Mautic
:hidden:

about/about
about/what_is_mautic
about/how_is_mautic_used
about/how_can_i_try_mautic

.. toctree::
:maxdepth: 2
Expand Down
7 changes: 7 additions & 0 deletions docs/links/mautic_documentation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
from . import link

link_name = "Mautic Documentation"
link_text = "Mautic Documentation"
link_url = "https://docs.mautic.org"

link.xref_links.update({link_name: (link_text, link_url)})
Loading