Home page of Docs website

docs-internships/docs-internship/docs-internship.md

@@ -0,0 +1,25 @@
+---
+id: internships
+title: Internship Opportunities
+description: Learn about our internship programs like GSoC and Calico.
+---
+
+# Internship Opportunities
+
+The Palisadoes Foundation is excited to offer various internship opportunities. Below are details for upcoming internship programs, including Google Summer of Code (GSoC) and Calico internships.
+
+## Google Summer of Code (GSoC)
+
+- **Overview**: Introduction to GSoC and how it works.
+- **How to Apply**: Steps to apply for GSoC with Palisadoes Foundation.
+- **Tips for Success**: Guidance on submitting a successful application.
+
+## Calico Internships
+
+- **Overview**: Description of Calico internships.
+- **How to Apply**: Steps for applying for Calico internships.
+- **Application Timeline**: Important dates for application submissions.
+
+## Join Us!
+
+Apply now to be part of our growing community and contribute to exciting open-source projects.

docs-projects/getting-started/getting-started.md

@@ -0,0 +1,21 @@
+---
+id: projects
+title: Projects
+description: Explore the Palisadoes Foundation open-source projects.
+---
+
+# Palisadoes Foundation Projects
+
+Welcome to the list of Palisadoes Foundation projects! Here you can explore different open-source projects that we’re working on. Feel free to contribute, learn, and grow with us!
+
+## Projects
+
+- **Project 1**: [Link to documentation](#)
+- **Project 2**: [Link to documentation](#)
+- **Project 3**: [Link to documentation](#)
+
+## How to Contribute
+
+- Fork the repository
+- Read our [contributing guidelines](#)
+- Submit a pull request!

docs/get-started/first-contribution.md

@@ -0,0 +1,40 @@
+# Collaborate
+
+## Fetching work of other Contributors
+
+At Talawa, We love collaboration and coordination amongst contributors. What happens when you would like to collaborate with another contributor and they have some work done in their own fork of Talawa? No problem! Just add their fork as a remote and Pull their changes.
+
+```
+$ git remote add <username> https://github.com/<username>/talawa-docs.git
+$ git fetch <username>
+```
+
+Now you can check out their branch just like you would any other. You can name the branch anything you want, but using both the username and branch name will help you keep things organized.
+
+```
+$ git checkout -b <username>/<branchname>
+```
+
+You can choose to rename the branch if you prefer:
+
+```
+$ git checkout -b <custombranchname> <username>/<branchname>
+```
+
+## Check out a Pull request locally
+
+We saw above how to fetch a user's branch locally. you can also check out any pull request locally. Github provides a special method [details](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally) for this since pull requests are specific to Github rather than Git.
+
+First, fetch and create a branch for the pull request, replacing **ID** and **BRANCHNAME** with the ID of the pull request and your desired branch name:
+
+```
+$ git fetch upstream pull/ID/head:BRANCHNAME
+```
+
+Now switch to the branch
+
+```
+$ git checkout BRANCHNAME
+```
+
+Now you can work on this branch as you normally work in other branch.

docs/get-started/installation.md

@@ -0,0 +1,68 @@
+---
+id: get-the-code
+title: Get The Code
+---
+
+Each of our projects use a **forked-repo** and **merge-oriented** workflow. This means all contributors create a fork of the repository they want to contribute to and then submit pull requests to the upstream repository to have their contributions reviewed and accepted. We also recommend you work on feature branches.
+
+## Step 1: Create Your Fork
+
+Forking is the process of creating a copy of our repository in your personal GitHub account. This only needs to be done once for each repository you want to work on.
+
+[Follow these steps to fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the appropriate [Palisadoes Foundation GitHub project repositiory](https://github.com/PalisadoesFoundation).
+
+## Step 2: Clone Your Fork
+
+Cloning is the process of creating a copy of a repository on your local machine. We'll show you how to clone your fork to your local machine.
+
+In this case will use the [Talawa-Docs repository](https://github.com/PalisadoesFoundation/talawa-docs) as our example:
+
+```
+git clone https://github.com/YOUR_USERNAME/talawa-docs.git
+Cloning into 'talawa'
+remote: Counting objects: 86768, done.
+remote: Compressing objects: 100% (15/15), done.
+remote: Total 86768 (delta 5), reused 1 (delta 1), pack-reused 86752
+Receiving objects: 100% (86768/86768), 112.96 MiB | 523.00 KiB/s, done.
+Resolving deltas: 100% (61106/61106), done.
+Checking connectivity... done.
+```
+
+:::note
+If you receive an error while cloning, you may not have added your ssh key to GitHub.
+:::
+
+## Step 3: Connect Your Local Repo to Ours
+
+An upstream repository is the one you originally forked. You will need to connect to it so that you can easily download our latest updates when required.
+
+1. This tutorial shows how to [configure an upstream remote repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork) for your fork of the repository.
+1. Configuring and upstream repository allows you to [sync changes](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork) from the main project back into your fork through the repository on your local machine.
+
+Here are the steps:
+
+1. Verify the currently configured remote repository:
+
+   ```
+   $ git remote -v
+   origin  https://github.com/YOUR_USERNAME/talawa-docs.git (fetch)
+   origin  https://github.com/YOUR_USERNAME/talawa-docs.git (push)
+   ```
+
+1. Add the Upstream using the `git remote add upstream` command:
+
+   ```
+   $ git remote add upstream https://github.com/PalisadoesFoundation/talawa-docs.git
+   ```
+
+1. Confirm that the new remote repository, upstream, has been configured:
+
+   ```
+   $ git remote -v
+   origin  https://github.com/YOUR_USERNAME/talawa-docs.git (fetch)
+   origin  https://github.com/YOUR_USERNAME/talawa-docs.git (push)
+   upstream https://github.com/PalisadoesFoundation/talawa-docs.git (fetch)
+   upstream https://github.com/PalisadoesFoundation/talawa-docs.git (push)
+   ```
+
+Now your forked repository is ready for your contributions on your local machine!

docs/get-started/introduction.md

@@ -0,0 +1,31 @@
+# Using Git as you work
+
+## Know what branch you're currently working on
+
+When working with Git, it's crucial to know which branch you have currently checked out, Most of the Git commands implicitly operate on the current branch. you can determine the currently checked out branch in several ways:
+
+One of the most common ways is with [git status](https://git-scm.com/docs/git-status)
+
+```
+$ git status
+on branch git-demo
+nothing to commit, working directory clean
+```
+
+Another is with [git branch](https://git-scm.com/docs/git-branch) which will display all local branches, with a star icon next to the current branch:
+
+```
+$ git branch
+* git-demo
+  main
+```
+
+You can see more detailed information about your branches, including remote branches, to do the same use, `git branch -vva`
+
+```
+$ git branch -vva
+  develop                3ca006a [origin/develop] Updating talawa documentation as new PR merged into talawa:automated-docs
+* docs                   3ca006a Updating talawa documentation as new PR merged into talawa:automated-docs
+  remotes/origin/HEAD    -> origin/develop
+  remotes/origin/develop 3ca006a Updating talawa documentation as new PR merged into talawa:automated-docs
+```

docs/introduction/introduction.md

@@ -1,5 +1,5 @@
 ---
-title: Introduction
+title: Palisadoes Documentation
 id: introduction
 slug: /
 ---

docusaurus.config.ts

@@ -2,31 +2,21 @@ import { themes as prismThemes } from "prism-react-renderer";
 import type { Config } from "@docusaurus/types";
 import type * as Preset from "@docusaurus/preset-classic";
 
-// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
-
 const config: Config = {
   title: "Palisadoes DevDocs",
   tagline: "Start your open source journey here",
   favicon: "img/favicon.ico",
 
-  // Set the production url of your site here
   url: "https://developer.palisadoes.org",
-  // Set the /<baseUrl>/ pathname under which your site is served
-  // For GitHub pages deployment, it is often '/<projectName>/'
   baseUrl: "/",
   deploymentBranch: "gh-pages",
 
-  // GitHub pages deployment config.
-  // If you aren't using GitHub pages, you don't need these.
-  organizationName: "PalisadoesFoundation", // Usually your GitHub org/user name.
-  projectName: "developer-docs", // Usually your repo name.
+  organizationName: "PalisadoesFoundation", // GitHub org
+  projectName: "developer-docs", // repo name
 
   onBrokenLinks: "throw",
   onBrokenMarkdownLinks: "warn",
 
-  // Even if you don't use internationalization, you can use this field to set
-  // useful metadata like html lang. For example, if your site is Chinese, you
-  // may want to replace "en" with "zh-Hans".
   i18n: {
     defaultLocale: "en",
     locales: ["en"],
@@ -38,8 +28,6 @@ const config: Config = {
       {
         docs: {
           sidebarPath: "./sidebars.ts",
-          // Please change this to your repo.
-          // Remove this to remove the "edit this page" links.
           editUrl:
             "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
         },
@@ -49,14 +37,8 @@ const config: Config = {
             type: ["rss", "atom"],
             xslt: true,
           },
-          // Please change this to your repo.
-          // Remove this to remove the "edit this page" links.
           editUrl:
             "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
-          // Useful options to enforce blogging best practices
-          onInlineTags: "warn",
-          onInlineAuthors: "warn",
-          onUntruncatedBlogPosts: "warn",
         },
         theme: {
           customCss: "./src/css/custom.css",
@@ -66,15 +48,36 @@ const config: Config = {
   ],
 
   themeConfig: {
-    // Replace with your project's social card
+    search: {
+      enabled: true,
+    },
+    docs: {
+      sidebar: {
+        autoCollapseCategories: true,
+      },
+    },
     image: "img/docusaurus-social-card.jpg",
     navbar: {
       title: "Palisadoes Developers",
-      logo: {
-        alt: "My Site Logo",
-        src: "img/logo.svg",
-      },
-      items: [{ to: "/docs", label: "Docs", position: "left" }],
+      logo: { alt: "My Site Logo", src: "img/talawa-logo-200x200.png" },
+      items: [
+        { to: "/docs", label: "Docs", position: "left" },
+        {
+          href: "https://github.com/PalisadoesFoundation",
+          html: '<i class="fab fa-github"></i> <span id="github-stars"></span>',
+          position: "right",
+          "aria-label": "GitHub Stars",
+          className: "custom-icon-link",
+        },
+        {
+          href: "https://www.linkedin.com/company/palisadoes/posts/?feedView=all",
+          html: '<i class="fab fa-linkedin"></i>',
+          position: "right",
+          "aria-label": "LinkedIn",
+          className: "custom-icon-link",
+        },
+        { type: "search", position: "right" },
+      ],
     },
     footer: {
       style: "dark",