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 Legal & Finance team section to RST #225

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 Legal & Finance team section: https://contribute.mautic.org/legal-and-finance-team. You can also update and improve the content on these pages if you like - do check with the team lead (ping me @RCheesley directly on Slack) 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'd like to take on the task of converting the Legal & Finance section to RST. I believe my understanding of the project's structure and familiarity with RST make me a good fit for this task. Kindly assign me this issue under Hacktoberfest 2024 so I can contribute to the project and fulfill my Hacktoberfest requirement.

RCheesley commented 2 days ago

Thanks for the enthusiastic responses @HappySR ! As we have a lot of interested contributors, I'll open up this PR for others, until you've completed #224.