some formatting,ordering and naming fixes

Tlazypanda · Tlazypanda · commit 9bedfab9d851 · 2020-10-25T20:26:58.000+05:30
diff --git a/docs/DeveloperWorkflow/bots_and_integrations.rst b/docs/DeveloperWorkflow/bots_and_integrations.rst
@@ -20,41 +20,41 @@ This bot is created and maintained by the `all-contributors` organisation `here
 
     @all-contributors please add <username> for <contributions>
 
-* <contribution>: See the `Emoji Key (Contribution Types Reference) <https://allcontributors.org/docs/en/emoji-key>`_ for a list of valid contribution types.
+    * <contribution> : See the `Emoji Key (Contribution Types Reference) <https://allcontributors.org/docs/en/emoji-key>`_ for a list of valid contribution types.
 
 * **Intent-Based Bot** : Your request to the bot doesn't need to be perfect. The bot will use basic Natural Language Parsing to determine your intent. For example, this will work too:
 
 ::
 
-  Jane you are crushing it in documentation and your infrastructure work has been great too. Let's 
+  Jane you are crushing it in documentation and your infrastructure work has been great too. Let's
   add jane.doe23 for her contributions. cc @all-contributors``
 
 * The bot will then create a Pull Request to add the contributor, then reply with the pull request details.
 
 Contributing
 ============
 
-If you wish to configure or modify the bot settings according to the needs of the repository, you may update the  ``.all-contributorsrc`` JSON file. The data used to generate the contributors list will be stored in there, and you can configure how you want @all-contributors to generate the list.
+If you wish to configure or modify the bot settings according to the needs of the repository, you may update the  ``.all-contributorsrc`` JSON file. The data used to generate the contributors list will be stored in there, and you can configure how you want ``@all-contributors`` to generate the list.
 Here are more details on the `configuration options <https://allcontributors.org/docs/en/bot/configuration>`_ available.
 
 
 Botmojaglobal
 -------------
 
-Botmojaglobal uses @zulipbot, a GitHub workflow bot from the zulip organisation, to handle issues and pull requests in our repositories in order to create a better workflow for contributors.
-This bot is created and maintained by the `zulip` organisation `here <https://github.com/zulip/zulipbot>`_.
+Botmojaglobal uses **@zulipbot**, a GitHub workflow bot from the zulip organisation, to handle issues and pull requests in our repositories in order to create a better workflow for contributors.
+This bot is created and maintained by the **zulip** organisation `here <https://github.com/zulip/zulipbot>`_.
 
 **Usage**
 =========
-* **Claim an issue** : Comment ``@botmojaglobal claim`` on the issue you want to claim; @botmojaglobal will assign you to the issue and label the issue as ``in progress``.
+* **Claim an issue** : Comment ``@botmojaglobal claim`` on the issue you want to claim; **@botmojaglobal** will assign you to the issue and label the issue as ``in progress``.
 
-  * If you’re a new contributor, @botmojaglobal will give you read-only collaborator access to the repository and leave a welcome message on the issue you claimed.
+  * If you’re a new contributor, **@botmojaglobal** will give you read-only collaborator access to the repository and leave a welcome message on the issue you claimed.
 
   * You can also claim an issue that you’ve opened by including ``@botmojaglobal claim`` in the body of your issue.
 
   * If you accidentally claim an issue you didn’t want to claim, comment ``@botmojaglobal abandon`` to abandon an issue.
 
-* **Label your issues** : Add appropriate labels to issues that you opened by including @botmojaglobal add in an issue comment or the body of your issue followed by the desired labels enclosed within double quotes ("").
+* **Label your issues** : Add appropriate labels to issues that you opened by including **@botmojaglobal** add in an issue comment or the body of your issue followed by the desired labels enclosed within double quotes ("").
 
   * For example, to add the bug and help wanted labels to your issue, comment or include ``@botmojaglobal add "bug" "help wanted"`` in the issue body.
 
@@ -64,25 +64,25 @@ This bot is created and maintained by the `zulip` organisation `here <https://gi
 
 * **Find unclaimed issues** : Use the `GitHub search feature <https://help.github.com/en/articles/using-search-to-filter-issues-and-pull-requests>`_ to find unclaimed issues by adding one of the following filters to your search:
 
-  * -label: "in progress" (excludes issues labeled with the in progress label)
+  * -label: ``in progress`` (excludes issues labeled with the in progress label)
 
   * no:assignee (shows issues without assignees)
 
-  Issues labeled with the in progress label and/or assigned to other users have already been claimed.
+  Issues labeled with the ``in progress`` label and/or assigned to other users have already been claimed.
 
-* **Track inactive claimed issues** : If a claimed issue has not been updated for a week, @botmojaglobal will post a comment on the inactive issue to ask the assignee(s) if they are still working on the issue.
+* **Track inactive claimed issues** : If a claimed issue has not been updated for a week, **@botmojaglobal** will post a comment on the inactive issue to ask the assignee(s) if they are still working on the issue.
 
-  * If you see this comment on an issue you claimed, you should post a comment on the issue to notify @botmojaglobal that you’re still working on it.
+  * If you see this comment on an issue you claimed, you should post a comment on the issue to notify **@botmojaglobal** that you’re still working on it.
 
-  * If @botmojaglobal does not receive a response from the assignee within 3 days of an inactive issue prompt, @botmojaglobal will automatically remove the issue’s current assignee(s) and the “in progress” label to allow others to work on an inactive issue.
+  * If **@botmojaglobal** does not receive a response from the assignee within 3 days of an inactive issue prompt, **@botmojaglobal** will automatically remove the issue’s current assignee(s) and the ``in progress`` label to allow others to work on an inactive issue.
 
 Contributing
 ============
-If you wish to help develop and contribute to @botmojaglobal, check out the `mojaglobal/zulipbot  <https://github.com/moja-global/zulipbot>`_ repository fork on GitHub and read the project’s contributing guidelines for more information.
+If you wish to help develop and contribute to **@botmojaglobal**, check out the `mojaglobal/zulipbot  <https://github.com/moja-global/zulipbot>`_ repository fork on GitHub and read the project’s contributing guidelines for more information.
 
 Welcome Bot
 -----------
-Welcome Bot is a `github app <https://github.com/apps/welcome>`_ that welcomes new users based off maintainer defined comments that should be located in a .github/config.yml. This app is configured for moja global in order to provide a richer experience to all new contributors.
+Welcome Bot is a `github app <https://github.com/apps/welcome>`_ that welcomes new users based off maintainer defined comments that should be located in a ``.github/config.yml``. This app is configured for moja global in order to provide a richer experience to all new contributors.
 This bot is created and maintained by the `probot` organisation  `here <https://github.com/probot>`_.
 
 **Usage**
@@ -96,7 +96,7 @@ This bot is created and maintained by the `probot` organisation  `here <https://
 
   * firstPRMergeComment : This message is displayed whenever a new contributor's first pull request gets merged in the repository.
 
-* You can opt out of having the bot comment on first time pull requests, pull request merges, or new issues by not filling in a value for each of the above respective fields.
+You can opt out of having the bot comment on first time pull requests, pull request merges, or new issues by not filling in a value for each of the above respective fields.
 
 Contributing
 ============
diff --git a/docs/DeveloperWorkflow/index.rst b/docs/DeveloperWorkflow/index.rst
@@ -1,7 +1,7 @@
 .. _DeveloperWorkflow:
 
-GitHub Workflow Best Practices
-##############################
+GitHub Workflow
+###############
 
 moja global as an Open source organisation wants to provide their users the best possible collaborative experience while meeting their security requirements and limiting their maintenance effort.
 Working on a collaborative platform like GitHub at times can be  overwhelming, especially as the number of users and repositories grow within an organization.
@@ -14,8 +14,8 @@ Contents:
 .. toctree::
   :maxdepth: 1
 
-  reviewing
+  repository_maintenance
+  bots_and_integrations
   automated_checks
+  reviewing
   manual_testing_pr
-  bots_and_integrations
-  repository_maintenance
diff --git a/docs/DeveloperWorkflow/repository_maintenance.rst b/docs/DeveloperWorkflow/repository_maintenance.rst
@@ -1,7 +1,7 @@
 .. _DeveloperWorkflow:
 
-Repository maintenance under GitHub
-###################################
+GitHub Repository maintenance
+#############################
 
 This section guides contributors and maintainers on the guidelines to follow while setting up a new repository and maintaining it under moja global.
 
@@ -97,6 +97,7 @@ Creating and maintaining Project Boards
 Project boards on GitHub help you organize and prioritize your work by creating them for specific feature work, comprehensive roadmaps, or even release checklists.
 
 There are 2 types of project boards available:
+
 * Repository: Boards for use in a single repository.
 * Organization: Boards for use in a GitHub organization across multiple repositories (but private to organization members)
 
diff --git a/docs/DevelopmentSetup/index.rst b/docs/DevelopmentSetup/index.rst
@@ -1,20 +1,12 @@
 .. _DevelopmentSetup:
 
-Development Setup
-#################
+FLINT Development Setup
+#######################
 
 This section guides first-time contributors through installing FLINT development environment on Windows and Ubuntu.
 
 The recommended method for installing the FLINT development environment is on Windows using cmake, vcpkg and Visual Studio 2017 or 2019. Inorder to setup FLINT on Linux based systems, Docker containers are preferred. This method creates containers which are a simple way to build FLINT and all required dependencies.
 
-Contents:
-
-.. toctree::
-  :maxdepth: 1
-
-  windows_installation
-  docker_installation
-
 **Before Setting Up FLINT**
 
 - Please make sure that all the prerequisites required have been installed and configured correctly.
@@ -27,4 +19,6 @@ Contents:
   :maxdepth: 1
 
   git_and_github_guide
+  windows_installation
+  docker_installation
   FLINT.example_installation
diff --git a/docs/contributing/before_contribute.rst b/docs/contributing/before_contribute.rst
@@ -6,3 +6,15 @@ Before making a contribution
 * Please checkout our `Git and Github guide <../DevelopmentSetup/git_and_github_guide.html>`_ for detailed instructions on how to setup this project and make a pull request.
 * Please follow our `Code of Conduct <coc.html>`_ at all times.
 * Make sure your contribution follows the `moja global best contribution practices <code_contribution_best_practices.html>`_.
+
+Join our communication Channels
+===============================
+
+If you are new to moja global, joining our communication channels can help you connect with community members and fellow contributors who can help answer your queries. In case you are facing any issues with the project setup or are looking for issues to contribute to, this would be a good place to start.
+Please check out our `Join us <../contact.html>`_ section for more information on how to join our communication channels.
+
+Contributors Website
+====================
+
+If you are a first-timer then please checkout our `Contributor Website <https://contributors-website.herokuapp.com/>`_ . Here you can find out beginner friendly issues across all moja global repositories and even get featured as a new contributor!
+Along with checking out our Contributing workflow, you may also reach out to us through the contact form and share your interesting ideas with us!
diff --git a/docs/contributing/code_contribution_best_practices.rst b/docs/contributing/code_contribution_best_practices.rst
@@ -8,18 +8,18 @@ This guide is to inform new contributors about the best practices followed by mo
 Commit Guidelines
 -----------------
 
-* Make sure your commit is passing all the tests. If your commit is failing tests then please try to fix the same commit instead of making a new commit by using `git --amend`
+* Make sure your commit is passing all the tests. If your commit is failing tests then please try to fix the same commit instead of making a new commit by using ``git --amend``
 * Every commit should be directed to solve a single problem instead of trying to solve multiple issues at once. This encourages simplicity and also makes it easier for the reviewers to review.
 * If the code introduced in the commit decreases the coverage/requires tests, don't forget to add them too.
 
-Although it’s encouraged to make commits following these guidelines but incase you missed, you can always fix your history using `git rebase -i`.
+Although it’s encouraged to make commits following these guidelines but incase you missed, you can always fix your history using ``git rebase -i``.
 
 Commit Message Guidelines
 ----------------------------
 
 * Keep the commit message short but concise explaining your changes and the problem you are trying to solve.
 * Try to write the commit messages in an imperative tone for example:- 'Fix', 'Update', 'Add' instead of 'Fixed', 'Updated', 'Added'.
-* Reference the issue solved in the commit message, for example:- `Fixes #8293: Add login api unit tests`. This will automatically close the issue referenced when your pull request gets merged.
+* Reference the issue solved in the commit message, for example:- ``Fixes #8293: Add login api unit tests``. This will automatically close the issue referenced when your pull request gets merged.
 
 Developer Certificate of Origin
 -------------------------------
@@ -53,6 +53,7 @@ We encourage you to add the mentioned tools as plugins in your editor.
   - Coding enforcement: We know that the style guides are long and detailed and not always easy to adhere to. As such, the intention is to use `Clang-Tidy <http://clang.llvm.org/extra/clang-tidy/>`_ as a tool to check and correct code formatting as determined by the Google C++ style guide. This will be implemented as an automated check through the Continuous Integration system.
 
 
+
 - **Python Repositories**:
 
   moja global follows the Python Style guide PEP8 that provides coding conventions for Python code. It is fairly common for Python code to follow this style guide. It’s a great place to start since it’s already well-defined.
diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst
@@ -12,9 +12,9 @@ Contents:
 
 .. toctree::
   :maxdepth: 1
-  
+
   before_contribute
+  ways_to_contribute
   after_contribute
   code_contribution_best_practices
   coc
-  ways_to_contribute
diff --git a/docs/prerequisites/index.rst b/docs/prerequisites/index.rst
@@ -1,7 +1,7 @@
 .. _prerequisites:
 
-Prerequisites
-###############
+FLINT Prerequisites
+###################
 
 Before we take a leap into the process of development, please take a moment to verify if you have the necessary tools setup and skills to get started on this project.
 You should be familiar with the following :-
