Merge pull request #11560 from MisRob/docs-updates

Development and contributing guidelines updates
learningequality · Nov 30, 2023 · 90df456 · 90df456
2 parents b88a804 + 421f0bf
commit 90df456
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 31 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,19 +1,28 @@
-
 <!-- Also update README.md (duplicate) -->
+## How can I contribute?
 
-# How can I contribute?
-
-1. 📙 Skim through the [Kolibri developer documentation](https://kolibri-dev.readthedocs.io) to understand where to refer later on.
-2. 💻 Follow [Getting started](https://kolibri-dev.readthedocs.io/en/develop/getting_started.html) to set up your development server. Some of the [How To Guides](https://kolibri-dev.readthedocs.io/en/develop/howtos/index.html#howtos) may be handy too.
-3. 🔍 Search for issues tagged as [help wanted](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee) or [good first issue](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee).
-4. 🗣️ Ask us for an assignment in the comments of an issue you've chosen.
-
-Note that in times of increased contributions activity, it may take us a few days to reply. If you don't hear from us within a week, please reach out via [Kolibri GitHub Discussions](https://github.com/learningequality/kolibri/discussions).
+1. 📙 **Skim through the [Developer documentation](https://kolibri-dev.readthedocs.io)** to understand where to refer later on.
+2. 💻 **Follow the [Getting started](https://kolibri-dev.readthedocs.io/en/develop/getting_started.html) to set up your development server.** Some of the [How To Guides](https://kolibri-dev.readthedocs.io/en/develop/howtos/index.html#howtos) may be handy too.
+3. 🔍 **Search for issues tagged as [help wanted](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee) or [good first issue](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee).**
+4. 🗣️ **Ask us for an assignment in the comments of an issue you've chosen.** Please request assignment of a reasonable amount of issues at a time. Once you finish your current issue or two, you are welcome to ask for more.
 
 **❓ Where to ask questions**
 
-- For anything development related, refer to the [Kolibri developer documentation](https://kolibri-dev.readthedocs.io) at first. Some answers may already be there.
+- For anything development related, refer to the [Developer documentation](https://kolibri-dev.readthedocs.io) at first. Some answers may already be there.
 - For questions related to a specific issue or assignment requests, use the corresponding issue's comments section.
-- Visit [Kolibri GitHub Discussions](https://github.com/learningequality/kolibri/discussions) to ask about anything related to contributing to Kolibri, troubleshoot development server issues, or connect with other contributors.
+- Visit [GitHub Discussions](https://github.com/learningequality/kolibri/discussions) to ask about anything related to contributing or to troubleshoot development server issues.
+
+**👥 How to connect**
+
+- We encourage you to visit [GitHub Discussions](https://github.com/learningequality/kolibri/discussions) to connect with the Learning Equality team as well as with other contributors.
+- If you'd like to contribute on a regular basis, we are happy to invite you to our open-source community Slack channel. Get in touch with us at [email protected] to receive an invitation.
+
+---
+
+🕖 Please allow us a few days to reply to your comments. If you don't hear from us within a week, reach out via [GitHub Discussions](https://github.com/learningequality/kolibri/discussions).
+
+As soon as you open a pull request, it may take us a week or two to review it as we're a small team. We appreciate your contribution and will provide feedback.
+
+---
 
-*Thank you for your interest in contributing to Kolibri! The project was founded by volunteers dedicated to helping make educational materials more accessible to those in need, and every contribution makes a difference.*
+*Thank you for your interest in contributing! Learning Equality was founded by volunteers dedicated to helping make educational materials more accessible to those in need, and every contribution makes a difference.*
diff --git a/README.md b/README.md
@@ -33,17 +33,28 @@ If you have found a bug and are comfortable using Github and Markdown, you can c
 <!-- Also update CONTRIBUTING.md (duplicate) -->
 ## How can I contribute?
 
-1. 📙 Skim through the [Kolibri developer documentation](https://kolibri-dev.readthedocs.io) to understand where to refer later on.
-2. 💻 Follow [Getting started](https://kolibri-dev.readthedocs.io/en/develop/getting_started.html) to set up your development server. Some of the [How To Guides](https://kolibri-dev.readthedocs.io/en/develop/howtos/index.html#howtos) may be handy too.
-3. 🔍 Search for issues tagged as [help wanted](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee) or [good first issue](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee).
-4. 🗣️ Ask us for an assignment in the comments of an issue you've chosen.
-
-Note that in times of increased contributions activity, it may take us a few days to reply. If you don't hear from us within a week, please reach out via [Kolibri GitHub Discussions](https://github.com/learningequality/kolibri/discussions).
+1. 📙 **Skim through the [Developer documentation](https://kolibri-dev.readthedocs.io)** to understand where to refer later on.
+2. 💻 **Follow the [Getting started](https://kolibri-dev.readthedocs.io/en/develop/getting_started.html) to set up your development server.** Some of the [How To Guides](https://kolibri-dev.readthedocs.io/en/develop/howtos/index.html#howtos) may be handy too.
+3. 🔍 **Search for issues tagged as [help wanted](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+no%3Aassignee) or [good first issue](https://github.com/learningequality/kolibri/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+no%3Aassignee).**
+4. 🗣️ **Ask us for an assignment in the comments of an issue you've chosen.** Please request assignment of a reasonable amount of issues at a time. Once you finish your current issue or two, you are welcome to ask for more.
 
 **❓ Where to ask questions**
 
-- For anything development related, refer to the [Kolibri developer documentation](https://kolibri-dev.readthedocs.io) at first. Some answers may already be there.
+- For anything development related, refer to the [Developer documentation](https://kolibri-dev.readthedocs.io) at first. Some answers may already be there.
 - For questions related to a specific issue or assignment requests, use the corresponding issue's comments section.
-- Visit [Kolibri GitHub Discussions](https://github.com/learningequality/kolibri/discussions) to ask about anything related to contributing to Kolibri, troubleshoot development server issues, or connect with other contributors.
+- Visit [GitHub Discussions](https://github.com/learningequality/kolibri/discussions) to ask about anything related to contributing or to troubleshoot development server issues.
+
+**👥 How to connect**
+
+- We encourage you to visit [GitHub Discussions](https://github.com/learningequality/kolibri/discussions) to connect with the Learning Equality team as well as with other contributors.
+- If you'd like to contribute on a regular basis, we are happy to invite you to our open-source community Slack channel. Get in touch with us at [email protected] to receive an invitation.
+
+---
+
+🕖 Please allow us a few days to reply to your comments. If you don't hear from us within a week, reach out via [GitHub Discussions](https://github.com/learningequality/kolibri/discussions).
+
+As soon as you open a pull request, it may take us a week or two to review it as we're a small team. We appreciate your contribution and will provide feedback.
+
+---
 
-*Thank you for your interest in contributing to Kolibri! The project was founded by volunteers dedicated to helping make educational materials more accessible to those in need, and every contribution makes a difference.*
+*Thank you for your interest in contributing! Learning Equality was founded by volunteers dedicated to helping make educational materials more accessible to those in need, and every contribution makes a difference.*
diff --git a/docs/howtos/another_kolibri_instance.md b/docs/howtos/another_kolibri_instance.md
@@ -1,10 +1,8 @@
-## Running another kolibri instance alongside the development server
-
 This guide will walk you through the process of setting up and running another instance of Kolibri alongside your development server using the `pex` executable.
 
 ## Introduction
 
-As Kolibri's features continue to expand into remote content browsing, it's often necessary to test and experiment with another Kolibri instance running alongside your development server. One effective approach is to use the `pex` executable. This workflow is straightforward and can be employed independently of ZeroTier or even internet network access. Documenting these steps will provide a handy reference for both new team members and contributors.
+As Kolibri's features continue to expand into remote content browsing, it's often necessary to test and experiment with another Kolibri instance running alongside your development server. One effective approach is to use the `pex` executable. This workflow is straightforward and can be employed independently of ZeroTier or even internet network access. By following these steps, you can effectively simulate real-world scenarios and enhance your development workflow.
 
 ## Steps
 
@@ -22,7 +20,9 @@ As Kolibri's features continue to expand into remote content browsing, it's ofte
 
 - **Run another Kolibri instance:**
 
-  Open your terminal and navigate to the folder where you unzipped the `pex` file. Use the following command to start another Kolibri instance:
+  First, make sure you are using Python version <= 3.9.
+
+  Then, open your terminal and navigate to the folder where you unzipped the `pex` file. Use the following command to start another Kolibri instance:
 
   ```sh
   KOLIBRI_HOME="<foldername>" python <filename>.pex start
@@ -50,7 +50,3 @@ As Kolibri's features continue to expand into remote content browsing, it's ofte
   python <filename>.pex stop
   ```
   This will gracefully shut down the instance.
-
-## Conclusion
-
-Running another Kolibri instance alongside your development server using the `pex` executable is a convenient way to test and experiment with remote content browsing features. By following these steps, you can effectively simulate real-world scenarios and enhance your development workflow.
diff --git a/docs/howtos/another_kolibri_instance.rst b/docs/howtos/another_kolibri_instance.rst
@@ -1,6 +1,6 @@
 .. _another_kolibri_instance:
 
-Another Kolibri Instance
-========================
+Running another Kolibri instance alongside the development server
+=================================================================
 
 .. mdinclude:: ./another_kolibri_instance.md