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.

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 the onboarding section to RST #222

Open
RCheesley opened this issue Oct 2, 2024 · 3 comments · May be fixed by #236
Open

Convert the onboarding section to RST #222

RCheesley opened this issue Oct 2, 2024 · 3 comments · May be fixed by #236
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed

Comments

@RCheesley
Copy link
Member

RCheesley commented Oct 2, 2024

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 Onboarding section: https://contribute.mautic.org/on-boarding. You can also update and improve the content on these pages if you like - do check with the team leads 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:

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!

@RCheesley RCheesley added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers hacktoberfest labels Oct 2, 2024
@HappySR
Copy link

HappySR commented Oct 3, 2024

I'd like to take on the task of converting the onboarding 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
Copy link
Member Author

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.

@SahilWMI
Copy link

SahilWMI commented Oct 11, 2024

Hey @RCheesley , I'd like to help with this.

SahilWMI added a commit to SahilWMI/mautic-community-handbook that referenced this issue Oct 12, 2024
This PR fixes mautic#222  and adds the onboarding section to the new Community Handbook for Read the Docs.
SahilWMI added a commit to SahilWMI/mautic-community-handbook that referenced this issue Oct 12, 2024
This PR fixes mautic#222  and adds on-boarding section to the new Community Handbook for Read the Docs.
@SahilWMI SahilWMI linked a pull request Oct 12, 2024 that will close this issue
@RCheesley RCheesley moved this from Ready to In progress in Mautic's 2024 No/Low/Code Tasks Oct 15, 2024
@RCheesley RCheesley moved this from In progress to Ready in Mautic's 2024 No/Low/Code Tasks Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed
Projects
Status: Ready
Development

Successfully merging a pull request may close this issue.

3 participants