Merge pull request #2 from palisadoes/docs

Created Docusaurus

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug Report
+about: Create a report to help us improve.
+title: Bug Report
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1.
+2.
+3.
+4.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Actual behavior**
+A clear and concise description of how the code performed w.r.t expectations.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional details**
+Add any other context or screenshots about the feature request here.
+
+**Potential internship candidates**
+
+Please read this if you are planning to apply for a Palisadoes Foundation internship 
+- https://github.com/PalisadoesFoundation/developer-docs/issues/359
+

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,29 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: Feature Request
+labels: feature request
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. *At this time, we are not making any FOOTER changes.*
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Approach to be followed (optional)**
+A clear and concise description of approach to be followed.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+
+**Potential internship candidates**
+
+Please read this if you are planning to apply for a Palisadoes Foundation internship 
+- https://github.com/PalisadoesFoundation/developer-docs/issues/359
+

.github/dependabot.yaml

@@ -0,0 +1,18 @@
+# Configuration for automated dependency updates using Dependabot
+version: 2
+updates:
+  # Define the target package ecosystem
+  - package-ecosystem: "npm"
+    # Specify the root directory
+    directory: "/"
+    # Schedule automated updates to run weekly
+    schedule:
+      interval: "weekly"
+    # Labels to apply to Dependabot PRs
+    labels:
+      - "dependencies"
+    # Specify the target branch for PRs
+    target-branch: "main"
+    # Customize commit message prefix
+    commit-message:
+      prefix: "chore(deps):"

.github/pull_request_template.md

@@ -0,0 +1,40 @@
+ <!--
+Thanks for submitting a pull request! Please provide enough information so that others can review your pull request.
+-->
+
+**What kind of change does this PR introduce?**
+
+<!-- E.g. a bugfix, feature, refactoring, etc… -->
+
+**Issue Number:**
+
+Fixes #<!--Add related issue number here.-->
+
+**Did you add tests for your changes?**
+
+<!--Yes or No. Note: Add unit tests or automation tests for your code.-->
+
+**Snapshots/Videos:**
+
+<!--Add snapshots or videos wherever possible.-->
+
+**If relevant, did you update the documentation?**
+
+<!--Add link.-->
+
+**Summary**
+
+<!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? -->
+<!-- Try to link to an open issue for more information. -->
+
+**Does this PR introduce a breaking change?**
+
+<!-- If this PR introduces a breaking change, please describe the impact and a migration path for existing applications. -->
+
+**Other information**
+
+<!--Add extra information about this PR here-->
+
+**Have you read the [contributing guide](https://github.com/PalisadoesFoundation/developer-docs/blob/main/CONTRIBUTING.md)?**
+
+<!--Yes or No-->

.github/workflows/issues.yml

@@ -0,0 +1,34 @@
+##############################################################################
+##############################################################################
+#
+# NOTE!
+#
+# Please read the README.md file in this directory that defines what should 
+# be placed in this file
+#
+##############################################################################
+##############################################################################
+
+name: Issues Workflow
+on:
+  issues:
+      types: ['opened']
+jobs:
+  Opened-issue-label:
+    name: Adding Issue Label
+    runs-on: ubuntu-latest
+    steps:
+      - uses: Renato66/[email protected]
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          ignore-comments: true
+          default-labels: '["unapproved"]'
+
+  Issue-Greeting:
+    name: Greeting Message to User
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/first-interaction@v1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          issue-message: "Congratulations on making your first Issue! :confetti_ball: If you haven't already, check out our [Contributing Guidelines](https://github.com/PalisadoesFoundation/developer-docs/blob/main/CONTRIBUTING.md) and [Issue Reporting Guidelines](https://github.com/PalisadoesFoundation/developer-docs/blob/main/ISSUE_GUIDELINES.md) to ensure that you are following our guidelines for contributing and making issues."

.github/workflows/pull-request-target.yml

@@ -0,0 +1,67 @@
+##############################################################################
+##############################################################################
+#
+# NOTE!
+#
+# Please read the README.md file in this directory that defines what should 
+# be placed in this file 
+#
+##############################################################################
+##############################################################################
+
+name: PR Target Workflow
+on: 
+  pull_request_target:
+
+jobs:
+  PR-Greeting:
+    name: Pull Request Target
+    runs-on: ubuntu-latest
+    steps:
+      - name: Add the PR Review Policy
+        uses: thollander/actions-comment-pull-request@v2
+        with:
+          comment_tag: pr_review_policy
+          message: |
+            ## Our Pull Request Approval Process
+
+            We have these basic policies to make the approval process smoother for our volunteer team.
+
+            ### Testing Your Code
+
+            Please make sure your code passes all tests and there are no merge conflicts. 
+
+            The process helps maintain accurate and well-formatted documentation and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.
+
+            ### Reviewers
+
+            When your PR has been assigned reviewers contact them to get your code reviewed and approved via:
+
+            1. comments in this PR or
+            1. our slack channel
+
+            #### Reviewing Your Code
+
+            Your reviewer(s) will have the following roles:
+
+            1.  arbitrators of future discussions with other contributors about the validity of your changes
+            2.  point of contact for evaluating the validity of your work
+            3.  person who verifies matching issues by others that should be closed.
+            4.  person who gives general guidance in fixing your tests
+
+            ### CONTRIBUTING.md
+
+            Read our CONTRIBUTING.md file. Most importantly:
+
+            1. PRs with issues not assigned to you will be closed by the reviewer
+            1. Fix the first comment in the PR so that each issue listed automatically closes
+
+            ### Other
+
+            1. :dart: Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
+
+      - name: Greeting Message to User
+        uses: actions/first-interaction@v1
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          pr-message: "Congratulations on making your first PR! :confetti_ball: If you haven't already, check out our [Contributing Guidelines](https://github.com/PalisadoesFoundation/developer-docs/blob/-/CONTRIBUTING.md) and [PR Reporting Guidelines](https://github.com/PalisadoesFoundation/developer-docs/blob/-/PR_GUIDELINES.md) to ensure that you are following our guidelines for contributing and creating PR."

.github/workflows/pull-request.yml

@@ -0,0 +1,145 @@
+##############################################################################
+##############################################################################
+#
+# NOTE!
+#
+# Please read the README.md file in this directory that defines what should
+# be placed in this file
+#
+##############################################################################
+##############################################################################
+
+name: PR Workflow
+
+on:
+  pull_request:
+    branches:
+      - "**"
+
+env:
+  CODECOV_UNIQUE_NAME: CODECOV_UNIQUE_NAME-${{ github.run_id }}-${{ github.run_number }}
+
+jobs:
+  Code-Quality-Checks:
+    name: Performs linting, formatting, type-checking, checking for different source and target branch
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the Repository
+        uses: actions/checkout@v4
+
+      - name: Count number of lines
+        run: |
+          chmod +x ./.github/workflows/scripts/countline.py
+          ./.github/workflows/scripts/countline.py --lines 600
+
+      - name: Check if the source and target branches are different
+        if: ${{ github.event.pull_request.base.ref == github.event.pull_request.head.ref }}
+        run: |
+          echo "Source Branch ${{ github.event.pull_request.head.ref }}"
+          echo "Target Branch ${{ github.event.pull_request.base.ref }}"
+          echo "Error: Source and Target Branches are the same. Please ensure they are different."
+          exit 1
+
+  Check-Sensitive-Files:
+    if: ${{ github.actor != 'dependabot[bot]' && !contains(github.event.pull_request.labels.*.name, 'ignore-sensitive-files-pr') }}
+    name: Checks if sensitive files have been changed without authorization
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Get Changed Unauthorized files
+        id: changed-unauth-files
+        uses: tj-actions/changed-files@v45
+        with:
+          files: |
+            .env*
+            .github/**
+            package.json
+            package-lock.json
+            .gitignore
+            .nojekyll
+            CODEOWNERS
+            LICENSE
+            .coderabbit.yaml
+            ./*.md
+            docs/CNAME
+            docs/static/CNAME
+            docs/package.json
+            docs/sidebar*.js
+            docs/docusaurus.config.js
+            docs/babel.config.js
+            docs/tsconfig.json
+            .coderabbit.yaml
+
+      - name: List all changed unauthorized files
+        if: steps.changed-unauth-files.outputs.any_changed == 'true' || steps.changed-unauth-files.outputs.any_deleted == 'true'
+        env:
+          CHANGED_UNAUTH_FILES: ${{ steps.changed-unauth-files.outputs.all_changed_files }}
+        run: |
+          for file in ${CHANGED_UNAUTH_FILES}; do
+            echo "$file is unauthorized to change/delete"
+          done
+          echo "To override this, apply the 'ignore-sensitive-files-pr' label"          
+          exit 1
+
+  Count-Changed-Files:
+    if: ${{ github.actor != 'dependabot[bot]' }}
+    name: Checks if number of files changed is acceptable
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v45
+
+      - name: Echo number of changed files
+        env:
+          CHANGED_FILES_COUNT: ${{ steps.changed-files.outputs.all_changed_files_count }}
+        run: |
+          echo "Number of files changed: $CHANGED_FILES_COUNT"
+
+      - name: Check if the number of changed files is less than 100
+        if: steps.changed-files.outputs.all_changed_files_count > 100
+        env:
+          CHANGED_FILES_COUNT: ${{ steps.changed-files.outputs.all_changed_files_count }}
+        run: |
+          echo "Error: Too many files (greater than 100) changed in the pull request."
+          echo "Possible issues:"
+          echo "- Contributor may be merging into an incorrect branch."
+          echo "- Source branch may be incorrect please use develop as source branch."
+          exit 1
+
+  Test-Docusaurus-Deployment:
+    name: Test Deployment to https://docs-poller.switchmap-ng.io
+    runs-on: ubuntu-latest
+    needs: [Code-Quality-Checks]
+    # Run only dependabot
+    if: ${{ github.actor != 'dependabot[bot]' }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: yarn
+          cache-dependency-path: "docs/"
+      # Run Docusaurus in the ./docs directory
+      - name: Install dependencies
+        working-directory: ./docs
+        run: yarn install --frozen-lockfile
+      - name: Test building the website
+        working-directory: ./docs
+        run: yarn build
+
+  Check-Target-Branch:
+    if: ${{ github.actor != 'dependabot[bot]' }}
+    name: Check Target Branch
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check if the target branch is develop
+        if: github.event.pull_request.base.ref != 'develop'
+        run: |
+          echo "Error: Pull request target branch must be 'develop'. Please refer PR_GUIDELINES.md"
+          exit 1