Talawa API docs automation workflow created (PalisadoesFoundation#1353)

* Creating a separate repository named "talawa-api-docs" for automated documentation, workflow created

* GitHub reference added

Author: Nitya-Pasrija

.github/workflows/push.yml

@@ -81,3 +81,74 @@ jobs:
           verbose: true
           fail_ci_if_error: false
           name: '${{env.CODECOV_UNIQUE_NAME}}'  
+
+  Generate-Documentation:
+    name: Generate Documentation
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/automated-docs'
+    needs: Push-Workflow
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        
+      - name: Generate Documentation of HTML pages
+        run: |
+          npm install --global typedoc
+          npm install typedoc-plugin-markdown
+          npm i --save-dev @types/node
+          npx typedoc --entryPoints src --out talawa-api-docs --plugin typedoc-plugin-markdown --theme markdown --entryPointStrategy expand
+        
+      - name: Checking doc updated
+        id: DocUpdated
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            echo "updateDoc=true" >> $GITHUB_OUTPUT
+            echo -e "Documentation has been updated!!"
+          else
+            Green='0;32'
+            NoColor='\033[0m'
+            echo -e "${Green}No documentation updated${NoColor}"
+          fi
+          
+      - name: Set env variables
+        if: steps.DocUpdated.outputs.updateDoc
+        run: |
+          echo "commit_id=$(echo $(git rev-parse HEAD))" >> $GITHUB_ENV
+          echo "email=$(echo $(git log --pretty=format:"%ae" $commit_id))" >> $GITHUB_ENV
+        
+      - name: Update Doc
+        if: steps.DocUpdated.outputs.updateDoc
+        run: |
+          Green='0;32'
+          NoColor='\033[0m' 
+          git config --global user.name "${{github.actor}}"
+          git config --global user.email "${{env.email}}"
+          git add .
+          git commit -m "Update documentation"
+          git push
+          echo -e "🚀${Green} Hurrah! doc updated${NoColor}"
+      
+      - name: Create Documentation Artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: documentation-api
+          path: talawa-api-docs
+  
+  Copy-docs-to-talawa-docs:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/automated-docs'
+    needs: Generate-Documentation
+    steps:
+    - uses: actions/checkout@v3
+    - uses: dmnemec/[email protected]
+      env:
+        API_TOKEN_GITHUB: ${{ secrets.TALAWA_DOCS_SYNC }}    
+      with:
+        source_file: 'talawa-api-docs/'
+        destination_repo: 'PalisadoesFoundation/talawa-docs'
+        destination_branch: 'testing-workflows'
+        destination_folder: 'docs/'
+        user_email: '${{env.email}}'
+        user_name: '${{github.actor}}'
+        commit_message: 'Talawa API docs updated'
+      

CONTRIBUTING.md

@@ -278,7 +278,7 @@ Go to `http://localhost:4000/voyager` after running the development server to ex
 
 We use the [GraphQL Markdown](https://github.com/exogen/graphql-markdown) project to generate the documentation to describe the schema. To generate the same manually, you first need to start the development server locally with `npm run dev`, and then run the script `npm run generate:graphql-markdown`.
 
-You can then view the [generated documentation here](./docs/Schema.md).
+You can then view the [generated documentation here](./talawa-api-docs/modules.md).
 
 While we use a GitHub workflow to update ths schema documentation every time a PR is merged into the repository, it is highly advisable that if you making changes to the schema, then you should also update the schema documentation by the process described above.