search

mautic / mautic-community-handbook

A handbook for all things related to the Mautic Community
https://contribute.mautic.org
7 stars 25 forks source link

Convert Education team section to RST #224

Open RCheesley opened 3 days ago

RCheesley commented 3 days ago

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.

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

Some useful resources:

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 commented 3 days ago

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 commented 2 days ago

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 commented 2 days ago

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 https://github.com/mautic/mautic-community-handbook/issues/224 to @HappySR https://github.com/HappySR.

— Reply to this email directly, view it on GitHub https://github.com/mautic/mautic-community-handbook/issues/224#event-14507209131, or unsubscribe https://github.com/notifications/unsubscribe-auth/BDSP6VDANLGVG4DXLXRPB3LZZVWITAVCNFSM6AAAAABPIVSALCVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJUGUYDOMRQHEYTGMI . You are receiving this because you were assigned.Message ID: @.*** .com>

HappySR commented 2 days ago

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 https://github.com/mautic/mautic-community-handbook/issues/224 to @HappySR https://github.com/HappySR.

— Reply to this email directly, view it on GitHub https://github.com/mautic/mautic-community-handbook/issues/224#event-14507209131, 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>