Convert Education team section to RST

[RCheesley]

We are in the process of moving this repository to Read the Docs, and to do that we need to convert our pages from Markdown to RST. This issue is to transfer the Education team section: https://contribute.mautic.org/education-team. You can also update and improve the content on these pages if you like - do check with the team lead (cc @favour-chibueze @fakela) first to ensure it's relevant.

You can do this in the current repo, as we've got a folder set up, /docs, which will be used for Read The Docs.

You can build this documentation locally by cloning this repository, and following these steps: https://github.com/mautic/user-documentation/tree/5.x?tab=readme-ov-file#build-documentation-locally. Change into the /docs folder and then (assuming you have DDEV and Docker/Colima installed) type ddev config and select build/html as the root folder when configuring DDEV. Then when complete, type ddev start and it'll give you the link to your local testing environment.

If you need to make a link file to add an external URL, please use the command line tool 'make link'. This will generate a reference macro and a link file for you.

For internal linking check the docs on using the :ref: role for linking within the same document, and using :doc: to link across pages.

Please note: if you see folders called .revs these are old version control files from Grav. Ignore them! (they should be deleted) and instead work on the actual files.

When you've converted the file/s, they need to live within the /docs folder. We can create a structure using sub-folders to organise the sections. You also need to add the pages to the Table of Contents in the index.rst file for them to show on the menu. Docs on the ToC can be found here.

We highly recommend that you use VS Code with Vale installed. Let us know if you have any problems.

Some useful resources:

• https://sublime-and-sphinx-guide.readthedocs.io/en/latest guide to Sphinx/RST formatting
• https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html#use-the-external-links-extension how to do external links - always check the /docs/links directory first! You can use the terminal command 'make link' to create the link file automagically.

There are many MD to RST tools out there which can help speed up the process, however you will still need to review your output to ensure it passes our Vale grammar rules. Headings must always be unique, as well.

We use the following for headings:

H1 ###
H2 ***
H3 ===
H4 ---
H5 ~~~

Please ask in #t-education on Slack if you get stuck with anything!

[HappySR]

I'm interested in taking on the task of converting the Education team section to RST. I believe my familiarity with RST and understanding of the project's structure make me a good fit for this task.

Kindly assign me this issue under Hacktoberfest 2024

[RCheesley]

Hi @HappySR thanks for your interest! Please take on one task at a time, which leaves other tasks open for other contributors. Feel free to start with this one, let us know if you require any guidance with the navigation/menu structure etc.

[HappySR]

Kindly tell me if i should keep the top part enclosed within --- as shown in the attachment, as RST is primarily used for technical documentation and focuses on structuring content using headings, paragraphs, lists, and code blocks. It doesn't have a built-in mechanism for handling metadata like YAML frontmatter.

…

On Thu, 3 Oct 2024 at 22:00, Ruth Cheesley ***@***.***> wrote: Assigned #224 <#224> to @HappySR <https://github.com/HappySR>. — Reply to this email directly, view it on GitHub <#224 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BDSP6VDANLGVG4DXLXRPB3LZZVWITAVCNFSM6AAAAABPIVSALCVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJUGUYDOMRQHEYTGMI> . You are receiving this because you were assigned.Message ID: ***@***.*** .com>

[HappySR]

For now i wrote that page like the one in the attachment, if any changes are needed kindly tell me

…

On Fri, 4 Oct 2024 at 10:27, Subhajit Roy ***@***.***> wrote: Kindly tell me if i should keep the top part enclosed within --- as shown in the attachment, as RST is primarily used for technical documentation and focuses on structuring content using headings, paragraphs, lists, and code blocks. It doesn't have a built-in mechanism for handling metadata like YAML frontmatter. On Thu, 3 Oct 2024 at 22:00, Ruth Cheesley ***@***.***> wrote: > Assigned #224 > <#224> to > @HappySR <https://github.com/HappySR>. > > — > Reply to this email directly, view it on GitHub > <#224 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/BDSP6VDANLGVG4DXLXRPB3LZZVWITAVCNFSM6AAAAABPIVSALCVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJUGUYDOMRQHEYTGMI> > . > You are receiving this because you were assigned.Message ID: > <mautic/mautic-community-handbook/issue/224/issue_event/14507209131@ > github.com> >