From 794e3a1563d8cbb6c595a4996f29242f393d9e78 Mon Sep 17 00:00:00 2001 From: Sahil Sharma <141577217+SahilWMI@users.noreply.github.com> Date: Sat, 12 Oct 2024 09:32:08 +0530 Subject: [PATCH 1/4] added on-boarding section This PR fixes #222 and adds on-boarding section to the new Community Handbook for Read the Docs. --- pages/08.on-boarding/{docs.md => docs.rst} | 46 +++++++++------------- 1 file changed, 19 insertions(+), 27 deletions(-) rename pages/08.on-boarding/{docs.md => docs.rst} (50%) diff --git a/pages/08.on-boarding/docs.md b/pages/08.on-boarding/docs.rst similarity index 50% rename from pages/08.on-boarding/docs.md rename to pages/08.on-boarding/docs.rst index 6f26370b..c0ee336e 100644 --- a/pages/08.on-boarding/docs.md +++ b/pages/08.on-boarding/docs.rst @@ -1,19 +1,10 @@ ---- -title: On-boarding -twitterenable: true -twittercardoptions: summary -articleenabled: false -orga: { } -personenabled: false -facebookenable: true -taxonomy: - category: - - docs ---- - -On-boarding new contributors effectively is a hugely important part of our community. - -If new contributors feel welcomed, able to use their time effectively and make a real difference which is recognised by the community, **we all benefit**. + +On-boarding +########### + +On-boarding new contributors effectively is a hugely important part of our community. + +If new contributors feel welcomed, able to use their time effectively and make a real difference which is recognised by the community, **we all benefit**. They feel their time is well spent, the Mautic project benefits from their skills and expertise, and **we all move forward together**. @@ -21,23 +12,24 @@ People need to be able to quickly determine how they can offer their skills, fin While each team will have some aspects of the on-boarding process in common, there are some elements which will be universal across all teams. -## General on-boarding - tools +General on-boarding - tools +*************************** -1. Anybody involved with the Mautic Community will need a Slack account - go to [mautic.org/slack][mautic-slack] to sign up. +1. Anybody involved with the Mautic Community will need a Slack account - go to `mautic.org/slack`_ to sign up. -2. Anybody contributing to Mautic teams will need to have a Google account, so that they can save their work in the shared [Google Drive folder][google-drive]. +2. Anybody contributing to Mautic teams will need to have a Google account, so that they can save their work in the shared `Google Drive folder`_. -3. The Mautic Community use Jira for task management in all teams. Go to [mautic.atlassian.net][mautic-jira] and sign up for a new account (free of charge). If you need any help please ask in #community on Slack. +3. The Mautic Community use Jira for task management in all teams. Go to `mautic.atlassian.net`_ and sign up for a new account (free of charge). If you need any help please ask in #community on Slack. -4. Anybody who is involved in code-based contributions will need to sign the Mautic Contributors Agreement, which can be done online [here][contributors-agreement]. +4. Anybody who is involved in code-based contributions will need to sign the Mautic Contributors Agreement, which can be done online `here`_. -5. Anybody who is involved with code, QA, testing or providing feedback will need to have a GitHub account, sign up at [github.com][github-signup]. +5. Anybody who is involved with code, QA, testing or providing feedback will need to have a GitHub account, sign up at `github.com`_. -[mautic-slack]: -[google-drive]: -[mautic-jira]: -[contributors-agreement]: -[github-signup]: +.. _mautic.org/slack: https://mautic.org/slack +.. _Google Drive folder: https://drive.google.com/drive/folders/1OrwJXmDrrlWK3f9nxRuru0YjS7-W-1-e?usp=sharing +.. _mautic.atlassian.net: https://mautic.atlassian.net +.. _here: https://www.mautic.org/contributor-agreement/ +.. _github.com: https://github.com/join From c61ae3e716676928708c4d5e6d975da770c12702 Mon Sep 17 00:00:00 2001 From: Sahil Sharma <141577217+SahilWMI@users.noreply.github.com> Date: Sat, 12 Oct 2024 17:38:18 +0530 Subject: [PATCH 2/4] added title metadata --- pages/08.on-boarding/docs.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/pages/08.on-boarding/docs.rst b/pages/08.on-boarding/docs.rst index c0ee336e..15a82352 100644 --- a/pages/08.on-boarding/docs.rst +++ b/pages/08.on-boarding/docs.rst @@ -1,3 +1,4 @@ +.. title:: On-boarding On-boarding ########### From 00d4c96861206e7d7ec15ecda82e4394a6fa6d72 Mon Sep 17 00:00:00 2001 From: Sahil Sharma <141577217+SahilWMI@users.noreply.github.com> Date: Sun, 20 Oct 2024 22:44:35 +0530 Subject: [PATCH 3/4] added meta data back into docs.rst --- pages/08.on-boarding/docs.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/pages/08.on-boarding/docs.rst b/pages/08.on-boarding/docs.rst index 15a82352..8557fdf6 100644 --- a/pages/08.on-boarding/docs.rst +++ b/pages/08.on-boarding/docs.rst @@ -1,4 +1,14 @@ -.. title:: On-boarding +.. title: On-boarding +.. twitterenable: true +.. twittercardoptions: summary +.. articleenabled: false +.. orga: {} +.. personenabled: false +.. facebookenable: true +.. taxonomy: + - category: + - docs + On-boarding ########### From 650a80b8224f05ed8b00fea4aaa4f40a1ffc0674 Mon Sep 17 00:00:00 2001 From: Sahil Sharma <141577217+SahilWMI@users.noreply.github.com> Date: Tue, 22 Oct 2024 18:33:56 +0530 Subject: [PATCH 4/4] revert changes and rename docs.rst to docs.md --- pages/08.on-boarding/{docs.rst => docs.md} | 57 ++++++++++------------ 1 file changed, 27 insertions(+), 30 deletions(-) rename pages/08.on-boarding/{docs.rst => docs.md} (50%) diff --git a/pages/08.on-boarding/docs.rst b/pages/08.on-boarding/docs.md similarity index 50% rename from pages/08.on-boarding/docs.rst rename to pages/08.on-boarding/docs.md index 8557fdf6..6f26370b 100644 --- a/pages/08.on-boarding/docs.rst +++ b/pages/08.on-boarding/docs.md @@ -1,21 +1,19 @@ -.. title: On-boarding -.. twitterenable: true -.. twittercardoptions: summary -.. articleenabled: false -.. orga: {} -.. personenabled: false -.. facebookenable: true -.. taxonomy: - - category: - - docs - - -On-boarding -########### - -On-boarding new contributors effectively is a hugely important part of our community. - -If new contributors feel welcomed, able to use their time effectively and make a real difference which is recognised by the community, **we all benefit**. +--- +title: On-boarding +twitterenable: true +twittercardoptions: summary +articleenabled: false +orga: { } +personenabled: false +facebookenable: true +taxonomy: + category: + - docs +--- + +On-boarding new contributors effectively is a hugely important part of our community. + +If new contributors feel welcomed, able to use their time effectively and make a real difference which is recognised by the community, **we all benefit**. They feel their time is well spent, the Mautic project benefits from their skills and expertise, and **we all move forward together**. @@ -23,24 +21,23 @@ People need to be able to quickly determine how they can offer their skills, fin While each team will have some aspects of the on-boarding process in common, there are some elements which will be universal across all teams. -General on-boarding - tools -*************************** +## General on-boarding - tools -1. Anybody involved with the Mautic Community will need a Slack account - go to `mautic.org/slack`_ to sign up. +1. Anybody involved with the Mautic Community will need a Slack account - go to [mautic.org/slack][mautic-slack] to sign up. -2. Anybody contributing to Mautic teams will need to have a Google account, so that they can save their work in the shared `Google Drive folder`_. +2. Anybody contributing to Mautic teams will need to have a Google account, so that they can save their work in the shared [Google Drive folder][google-drive]. -3. The Mautic Community use Jira for task management in all teams. Go to `mautic.atlassian.net`_ and sign up for a new account (free of charge). If you need any help please ask in #community on Slack. +3. The Mautic Community use Jira for task management in all teams. Go to [mautic.atlassian.net][mautic-jira] and sign up for a new account (free of charge). If you need any help please ask in #community on Slack. -4. Anybody who is involved in code-based contributions will need to sign the Mautic Contributors Agreement, which can be done online `here`_. +4. Anybody who is involved in code-based contributions will need to sign the Mautic Contributors Agreement, which can be done online [here][contributors-agreement]. -5. Anybody who is involved with code, QA, testing or providing feedback will need to have a GitHub account, sign up at `github.com`_. +5. Anybody who is involved with code, QA, testing or providing feedback will need to have a GitHub account, sign up at [github.com][github-signup]. -.. _mautic.org/slack: https://mautic.org/slack -.. _Google Drive folder: https://drive.google.com/drive/folders/1OrwJXmDrrlWK3f9nxRuru0YjS7-W-1-e?usp=sharing -.. _mautic.atlassian.net: https://mautic.atlassian.net -.. _here: https://www.mautic.org/contributor-agreement/ -.. _github.com: https://github.com/join +[mautic-slack]: +[google-drive]: +[mautic-jira]: +[contributors-agreement]: +[github-signup]: