Added README.md and Expanded Introduction Pages (#7)

* Removed packag-lock.json * Expanded introduction * Added logo * Added logo v2 * Added README.md * Added README.md v2 * Added README.md v3 * Added README.md v34 * Added README.md v4 * Added README.md v5 * Added README.md v6 * Added README.md * Added README.md v7 * Added README.md v7 * Added README.md * Added README.md * Added README.md
PalisadoesFoundation · Dec 15, 2024 · daa8f06 · daa8f06
1 parent 4c7ffec
commit daa8f06
Show file tree

Hide file tree

Showing 25 changed files with 5,481 additions and 18,353 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,12 @@
 
 .vscode
 
+##########################################################
+# NPM
+##########################################################
+
+package-lock.json
+
 ##########################################################
 # Vim editor
 ##########################################################

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,5 +1,5 @@
-# Contributing to Talawa Docs
-Thank you for your interest in contributing to Talawa Docs. Regardless of the size of the contribution you make, all contributions are welcome and are appreciated.
+# Contributing to our Project
+Thank you for your interest in contributing to our project. Regardless of the size of the contribution you make, all contributions are welcome and are appreciated.
 
 If you are new to contributing to open source, please read the Open Source Guides on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/).
 
@@ -8,27 +8,30 @@ We know you are ready to start contributing code right away! Hers is a list of [
 
 ## Quicklinks
 
-* [Our Development Process](#Our-development-process)
-    * [Issues](#issues)
-    * [Pull Requests](#pull-requests)
-    * [Git Flow](#git-flow)
-* [Contributing Code](#contributing-code)
-* [Internshhips](#internships)
-* [Community](#community)
+- [Contributing to our Project](#contributing-to-our-project)
+  - [Ways to Contribute](#ways-to-contribute)
+  - [Quicklinks](#quicklinks)
+    - [Our Development Process](#our-development-process)
+      - [Issues](#issues)
+      - [Pull Requests](#pull-requests)
+      - [Git Flow](#git-flow)
+    - [Contributing Code](#contributing-code)
+    - [Internships](#internships)
+  - [Community](#community)
 
 
 
 ### Our Development Process
 We utilize GitHub issues and pull requests to keep track of issues and contributions from the community.
 
 #### Issues
-Make sure you are following [issue report guidelines](ISSUE_GUIDELINES.md) available here before creating any new issues on Talawa API project.
+Make sure you are following [issue report guidelines](ISSUE_GUIDELINES.md) available here before creating any new issues to the project.
 
 #### Pull Requests
 [Pull Request guidelines](PR_GUIDELINES.md) is best resource to follow to start working on open issues.
 
 #### Git Flow
-For Talawa Docs, we utilize the GitFlow branching model. GitFlow is geared towards efficiently tracking development and managing releases. The model makes parallel development efforts easy and safe by isolating new development efforts from completed work.
+For this project, we utilize the GitFlow branching model. GitFlow is geared towards efficiently tracking development and managing releases. The model makes parallel development efforts easy and safe by isolating new development efforts from completed work.
 
 The different types of branches we may use are:
 * Feature branches (feature/branch-name)
@@ -39,28 +42,28 @@ The different types of branches we may use are:
 Detailed document containing how GitFlow works: https://nvie.com/posts/a-successful-git-branching-model/
 
 ### Contributing Code
-Code contributions to Talawa come in the form of pull requests. These are done by forking the repo and making changes locally.
+Code contributions to this project come in the form of pull requests. These are done by forking the repo and making changes locally.
 
 Make sure you have read the [Documentation for Setting up the Project](https://github.com/PalisadoesFoundation/developer-docs#readme)
 
-The process of proposing a change to Talawa Docs can be summarized as:
-1. Fork the Talawa Docs repository and branch off `master`.
+The process of proposing a change to this project can be summarized as:
+1. Fork the project repository and branch off `master`.
 2. The repository can be cloned locally using `git clone <forked repo url>`.
-3. Make the desired changes to the Talawa Docs source.
+3. Make the desired changes to the project source code.
 4. Run the website and test your changes.
 5. If you've added code that should be tested, write tests.
 6. After making changes you can add them to git locally using `git add <file_name>`(to add changes only in a particular file) or `git add .` (to add all changes).
 7. After adding the changes you need to commit them using `git commit -m '<commit message>'`(look at the commit guidelines below for commit messages).
 8. Once you have successfully commited your changes, you need to push the changes to the forked repo on github using: `git push origin <branch_name>`.(Here branch name must be name of the branch you want to push the changes to.)
-9. Now create a pull request to the Talawa Docs repository from your forked repo. Open an issue regarding the same and link your PR to it.
+9. Now create a pull request to the project repository from your forked repo. Open an issue regarding the same and link your PR to it.
 10. Ensure the test suite passes, either locally or on CI once a PR has been created.
 11. Review and address comments on your pull request if requested.
 
 ### Internships
-If you are participating in any of the various internship programs we ar members of then please read the [introduction guides on our documentation website](https://docs.talawa.io/docs/).
+If you are participating in any of the various internship programs we ar members of then please read the [internship introduction guides](https://developer.palisadoes.org/docs/category/internships).
 
 ## Community
 There are many ways to communicate with the community.
 
-1. The Palisadoes Foundation has a Slack channel where members can assist with support and clarification. Visit the [Talawa GitHub repository home page](https://github.com/PalisadoesFoundation/talawa) for the link to join our slack channel.
-1. We also have a technical email list run by [freelists.org](https://www.freelists.org/). Search for "palisadoes" and join. Members on this list are also periodically added to our marketing email list that focuses on less technical aspects of our work.
+1. The Palisadoes Foundation has a Slack channel where members can assist with support and clarification. Visit the [Palisadoes Foundation's GitHub repository home page](https://github.com/PalisadoesFoundation) for the link to join our slack channel.
+2. We also have a technical email list run by [freelists.org](https://www.freelists.org/). Search for "palisadoes" and join. Members on this list are also periodically added to our marketing email list that focuses on less technical aspects of our work.
diff --git a/INSTALLATION.md b/INSTALLATION.md
@@ -1,29 +1,31 @@
-# Talawa-Docs Installation
+# Developer-Docs Installation
 
 This document provides instructions on how to set up and start a running instance of developer-docs on your local system. The instructions are written to be followed in sequence so make sure to go through each of them step by step without skipping any sections.
 
 # Table of Contents
 
 <!-- /TOC -->
 
-1. [Pre-Requisites For Developers](#prerequisites-for-developers)
-   - [Install node.js](#install-nodejs)
-   - [Install git](#install-git)
-   - [Setting up this repository](#setting-up-this-repository)
-   - [Install the required packages](#install-the-required-packages)
-     - [Install Yarn on Windows Using NPM](#install-yarn-on-windows-using-npm)
-     - [Install Yarn on Windows Using msi-file](#install-yarn-on-windows-using-msi-file)
-     - [Install Yarn on MacOS Using NPM](#install-yarn-on-macos-using-npm)
-     - [Install Yarn on MacOS Using Homebrew](#install-yarn-on-macos-using-homebrew)
-     - [Install Yarn on Linux Using NPM](#install-yarn-on-linux-using-npm)
-1. [Running the Development Server](#running-the-development-server)
-1. [Building Static HTML Pages](#building-static-html-pages)
+- [Developer-Docs Installation](#developer-docs-installation)
+- [Table of Contents](#table-of-contents)
+- [Prerequisites for Developers](#prerequisites-for-developers)
+  - [Install node.js](#install-nodejs)
+  - [Install git](#install-git)
+  - [Setting up this repository](#setting-up-this-repository)
+  - [Install the Required Packages](#install-the-required-packages)
+    - [Install Yarn on Windows Using NPM](#install-yarn-on-windows-using-npm)
+    - [Install Yarn on Windows Using msi File](#install-yarn-on-windows-using-msi-file)
+    - [Install Yarn on macOS Using NPM](#install-yarn-on-macos-using-npm)
+    - [Install Yarn on macOS Using Homebrew](#install-yarn-on-macos-using-homebrew)
+    - [Install Yarn on Linux Using NPM](#install-yarn-on-linux-using-npm)
+- [Running the Development Server](#running-the-development-server)
+- [Building Static HTML Pages](#building-static-html-pages)
 
 # Prerequisites for Developers
 
-The contents of the `developer-docs` repo is used to automatically create [the talawa documentation website](https://docs.talawa.io/). The automation uses [Docusaurus](https://docusaurus.io/docs/), a modern static website generator.
+The contents of the `developer-docs` repo is used to automatically create [the Palisadoes Developer Documentation website](https://developer.palisadeos.org/). The automation uses [Docusaurus](https://docusaurus.io/docs/), a modern static website generator.
 
-We recommend that you follow these steps before beginning development work on the Talawa docs.
+We recommend that you follow these steps before beginning development work in this repository.
 
 ## Install node.js
 
@@ -37,11 +39,11 @@ Follow the setup guide for `git` on official [git docs](https://git-scm.com/down
 
 First you need a local copy of developer-docs. Run the following command in the directory of choice on your local system.
 
-1. Navigate to the folder where you want to setup the repository. Here, I will set it up in a folder called `talawa`.
-1. Navigate to the folder and open a terminal in this folder (you can right-click and choose appropiate option based on your OS). Next, we'll fork and clone the `developer-docs` repository.
-1. Navigate to [https://github.com/PalisadoesFoundation/developer-docs/](https://github.com/PalisadoesFoundation/developer-docs/) and click on the `fork` button. It is placed on the right corner opposite the repository name `PalisadoesFoundation/developer-docs`.
-1. You should now see `developer-docs` under your repositories. It will be marked as forked from `PalisadoesFoundation/developer-docs`
-1. Clone the repository to your local computer (replacing the values in `{{}}`):
+1. Navigate to the folder where you want to setup the repository. 
+2. Navigate to the folder and open a terminal in this folder (you can right-click and choose appropriate option based on your OS). Next, we'll fork and clone the `developer-docs` repository.
+3. Navigate to [https://github.com/PalisadoesFoundation/developer-docs/](https://github.com/PalisadoesFoundation/developer-docs/) and click on the `fork` button. It is placed on the right corner opposite the repository name `PalisadoesFoundation/developer-docs`.
+4. You should now see `developer-docs` under your repositories. It will be marked as forked from `PalisadoesFoundation/developer-docs`
+5. Clone the repository to your local computer (replacing the values in `{{}}`):
 
 ```
 $ git clone https://github.com/{{YOUR GITHUB USERNAME}}/developer-docs.git

diff --git a/ISSUE_GUIDELINES.md b/ISSUE_GUIDELINES.md
@@ -2,20 +2,20 @@
 
 :+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
 
-In order to give everyone a chance to submit a issues reports and contribute to the Talawa project, we have put restrictions in place. This section outlines the guidelines that should be imposed upon issue reports in the Talawa project.
+In order to give everyone a chance to submit a issues reports and contribute to our projects, we have put restrictions in place. This section outlines the guidelines that should be imposed upon issue reports in our projects.
 
 ___
 ## Table of Contents
 <!-- TOC -->
 
 - [Issue Report Guidelines](#issue-report-guidelines)
-    - [Table of Contents](#table-of-contents)
-    - [Issue Management](#issue-management)
-        - [New Issues](#new-issues)
-        - [Existing Issues](#existing-issues)
-        - [Feature Request Issues](#feature-request-issues)
-        - [Monitoring the Creation of New Issues](#monitoring-the-creation-of-new-issues)
-    - [General Guidelines](#general-guidelines)
+  - [Table of Contents](#table-of-contents)
+  - [Issue Management](#issue-management)
+    - [New Issues](#new-issues)
+    - [Existing Issues](#existing-issues)
+    - [Feature Request Issues](#feature-request-issues)
+    - [Monitoring the Creation of New Issues](#monitoring-the-creation-of-new-issues)
+  - [General Guidelines](#general-guidelines)
 
 <!-- /TOC -->
 ___
@@ -41,7 +41,7 @@ You can also be a valuable contributor by searching for dormant issues. Here's h
 1. **Previously Assigned Issues**: We regularly review issues and add a [`no-issue-activity`](https://github.com/PalisadoesFoundation/developer-docs/issues?q=is%3Aissue+is%3Aopen+label%3Ano-issue-activity) label to them. Use the issue comments to ask whether the assignee is still working on the issue, and if not, ask for the issue to be assigned to you.
 1. **Unassigned Issues**: If the issue is already reported and [not assigned to anyone](https://github.com/PalisadoesFoundation/developer-docs/issues?q=is%3Aissue+is%3Aopen+no%3Aassignee) and you are interested in working on the issue then:
    1. Ask for the issue to be assigned to you in the issue comments
-   2. Ask our contributors to assign it to you in `#talawa` slack channel.
+   2. Ask our contributors to assign it to you in our slack channel.
 
 Working on these types of existing issues is a good way of getting started with the community.
 
@@ -50,7 +50,7 @@ Working on these types of existing issues is a good way of getting started with
 Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the mentors of the merits of this feature. Please provide as much detail and context as possible.
 
 ### Monitoring the Creation of New Issues 
-1. Join our `#talawa-github` slack channel for automatic issue and pull request updates
+1. Join our slack channel for automatic issue and pull request updates
 
 ## General Guidelines
 

diff --git a/PR_GUIDELINES.md b/PR_GUIDELINES.md
@@ -2,7 +2,7 @@
 
 :+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
 
-In order to give everyone a chance to submit a pull request and contribute to the Talawa project, we have put restrictions in place. This section outlines the guidelines that should be imposed upon pull requests in the Talawa project.
+In order to give everyone a chance to submit a pull request and contribute to the project, we have put restrictions in place. This section outlines the guidelines that should be imposed upon pull requests in the project.
 
 ## Pull Requests and Issues
 1. Do not start working on any open issue and raise a PR unless the issue is assigned to you. PRs that don't meet these guidelines will be closed.

diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# Palisadeoes Developer Documentation
+
+💬 Join the community on Slack from our [Palisadoes Foundation GitHub Home Page](https://github.com/PalisadoesFoundation)
+
+[![N|Solid](static/img/markdown/misc/logo.png)](https://github.com/PalisadoesFoundation/developer-docs)
+
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![GitHub stars](https://img.shields.io/github/stars/PalisadoesFoundation/developer-docs.svg?style=social&label=Star&maxAge=2592000)](https://github.com/PalisadoesFoundation/developer-docs)
+[![GitHub forks](https://img.shields.io/github/forks/PalisadoesFoundation/developer-docs.svg?style=social&label=Fork&maxAge=2592000)](https://github.com/PalisadoesFoundation/developer-docs)
+
+## About Palisadoes
+
+The [Palisadoes Foundation’s](https://www.palisadoes.org) open-source software projects started in 2016 when a group of expatriate Jamaicans wanted to assist development of new and existing information technologies for the island’s social good. 
+
+Over the years the scope of our work has expanded. Our volunteers now live in all timezones of the globe and work on projects with a truly international scope.
+
+- [Our Website](https://www.palisadoes.org)<br>
+- [Our Developer Website](https://developer.palisadoes.org)
+
+## About This Repository
+
+This repo hosts the documentation you see on the https://developer.palisadoes.org site.
+
+## Documentation
+
+- Want to contribute? Look at [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
+
+