docs(gha): setup gha to build docs and ensure site builds

Author: lwasser

.github/workflows/build-website.yml

@@ -0,0 +1,45 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+      - docs
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+      - name: Build website
+        run: |
+          npm run build
+          ls website/build
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: website/build/all-contributors
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -11,8 +11,9 @@ desktop.ini
 # Optional eslint cache
 .eslintcache
 
-# npm
-package-lock.json
+# yarn
+#package-lock.json
+yarn.lock
 
 # Optional npm cache directory
 .npm

CONTRIBUTING.md

@@ -1,3 +1,14 @@
+# Contribute to the All Contributors bot
+
+We welcome contributions of all kinds to AllContributors.
+
+## 13 August 2025 Update:
+
+Currently, we are doing some work to revive the project. The documentation 
+website is not online but we are working to get it online soon. 
+
+************* THE LINKS BELOW DON'T CURRENTLY WORK ******
+
 Read the contributing docs in:
 
 - <a href="https://allcontributors.org/docs/en/project/contribute">English</a>

docs/emoji-key.md

@@ -8,41 +8,41 @@ sidebar_label: Emoji Key ✨
 
 > To have a contribution added when using the [Bot](bot/overview) or [CLI](cli/overview) use the keyword in the `Type` column. The bot will also use [basic Natural Language Parsing](https://github.com/all-contributors/app/blob/master/lib/parse-comment.js) to determine your contribution intent.
 
-Emoji/Type | Represents | Comments
-:---: | :---: | :---:
-🔊 <br /> `audio` | Audio | Podcasts, background music or sound effects
-♿️ <br /> `a11y` | Accessibility | Reporting or working on accessibility issues
-🐛 <br /> `bug` | Bug reports | Links to issues reported by the user on this project
-📝 <br /> `blog` | Blogposts | Links to the blogpost
-💼 <br /> `business` | Business Development | People who execute on the business end
-💻 <br /> `code` | Code | Links to commits by the user on this project
-🖋 <br /> `content` | Content | e.g. website copy, blog posts are separate
-🔣 <br /> `data` | Data | Links to contributed data for the project (both tests and datasets)
-📖 <br /> `doc` | Documentation | Links to commits by the user on this project, Wiki, or other source of documentation
-🎨 <br /> `design` | Design | Links to the logo/iconography/visual design/etc.
-💡 <br /> `example` | Examples | Links to the examples
+Emoji/Type | Represents | Comments |
+:---: | :---: | :---: |
+🔊 <br /> `audio` | Audio | Podcasts, background music or sound effects |
+♿️ <br /> `a11y` | Accessibility | Reporting or working on accessibility issues |
+🐛 <br /> `bug` | Bug reports | Links to issues reported by the user on this project |
+📝 <br /> `blog` | Blogposts | Links to the blogpost |
+💼 <br /> `business` | Business Development | People who execute on the business end |
+💻 <br /> `code` | Code | Links to commits by the user on this project |
+🖋 <br /> `content` | Content | e.g. website copy, blog posts are separate |
+🔣 <br /> `data` | Data | Links to contributed data for the project (both tests and datasets) |
+📖 <br /> `doc` | Documentation | Links to commits by the user on this project, Wiki, or other source of documentation |
+🎨 <br /> `design` | Design | Links to the logo/iconography/visual design/etc. |
+💡 <br /> `example` | Examples | Links to the examples |
 📋 <br /> `eventOrganizing` | Event Organizers | Links to event page |
-💵 <br /> `financial` | Financial Support | People or orgs who provide financial support, links to relevant page
-🔍 <br /> `fundingFinding` | Funding/Grant Finders | People who help find financial support
+💵 <br /> `financial` | Financial Support | People or orgs who provide financial support, links to relevant page |
+🔍 <br /> `fundingFinding` | Funding/Grant Finders | People who help find financial support |
 🤔 <br /> `ideas` | Ideas & Planning | |
-🚇 <br /> `infra` | Infrastructure | Hosting, Build-Tools, etc. Links to source file (like `travis.yml`) in repo, if applicable
-🚧 <br /> `maintenance` | Maintenance | People who help in maintaining the repo, links to commits by the user on this project
-🧑‍🏫 <br /> `mentoring` | Mentoring | People who mentor new contributors, links to the repo home
+🚇 <br /> `infra` | Infrastructure | Hosting, Build-Tools, etc. Links to source file (like `travis.yml`) in repo, if applicable |
+🚧 <br /> `maintenance` | Maintenance | People who help in maintaining the repo, links to commits by the user on this project |
+🧑‍🏫 <br /> `mentoring` | Mentoring | People who mentor new contributors, links to the repo home |
 📦 <br /> `platform` | Packaging | Porting to support a new platform |
-🔌 <br /> `plugin` | Plugin/utility libraries | Links to the repo home
+🔌 <br /> `plugin` | Plugin/utility libraries | Links to the repo home |
 📆 <br /> `projectManagement` | Project Management | |
 📣 <br /> `promotion` | Promotion | |
-💬 <br /> `question` | Answering Questions | Answering Questions in Issues, Stack Overflow, Gitter, Slack, etc.
-🔬 <br /> `research` | Research | Literature review.
+💬 <br /> `question` | Answering Questions | Answering Questions in Issues, Stack Overflow, Gitter, Slack, etc. |
+🔬 <br /> `research` | Research | Literature review. |
 👀 <br /> `review` | Reviewed Pull Requests | |
-🛡️ <br /> `security` | Security | Identify and/or reduce security threats, GDPR, Privacy, etc
-🔧 <br /> `tool` | Tools | Links to the repo home
-🌍 <br /> `translation` | Translation | Links to the translated content
-⚠️ <br /> `test` | Tests | Links to commits by the user on this project
-✅ <br /> `tutorial` | Tutorials | Links to the tutorial
-📢 <br /> `talk` | Talks | Links to the slides/recording/repo/etc
-📓 <br /> `userTesting` | User Testing | Links to user test notes
-📹 <br /> `video` | Videos | Links to the video
+🛡️ <br /> `security` | Security | Identify and/or reduce security threats, GDPR, Privacy, etc |
+🔧 <br /> `tool` | Tools | Links to the repo home |
+🌍 <br /> `translation` | Translation | Links to the translated content |
+⚠️ <br /> `test` | Tests | Links to commits by the user on this project |
+✅ <br /> `tutorial` | Tutorials | Links to the tutorial |
+📢 <br /> `talk` | Talks | Links to the slides/recording/repo/etc |
+📓 <br /> `userTesting` | User Testing | Links to user test notes |
+📹 <br /> `video` | Videos | Links to the video |
 
 ## What's next
 

docs/project/contribute.md

@@ -62,15 +62,41 @@ After you translate strings in any given language, you won't see those changes a
 
 Search is by algolia, the configuration is at <https://github.com/algolia/docsearch-configs/blob/master/configs/all-contributors.json>
 
-## Running the site locally:
+## Run the website locally:
 
-All Contributors uses Docusaurus to maintain our documentation website. For more info visit the [Docusaurus Website](https://docusaurus.io)
+All Contributors currently uses [Docusaurus 1.x](https://docusaurus.io) for our documentation website.
 
-To get started locally:
+To build the docs locally:
 
-- `yarn install`
-- `yarn start`
-- go to `http://localhost:3000` (Refresh the page for your changes to be reflected)
+* https://tutorial.docusaurus.io/docs/intro
+
+1. Make sure `npm` is installed on your machine. Use the [nodejs documentation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) if you aren't sure how to install `npm`.
+
+To check that npm is installed run the following in your favorite shell:
+
+`npm -v`
+
+Next, make sure you have atleast node version 0.22 or higher. To check the version,
+use:
+
+`node -v`
+
+If you don't have atleast version `.22` or higher, please install node or upgrade your current version.
+
+Install the newest (deprecated) version of Docusaurus:
+
+`npm install docusaurus@1.14.7 --save-dev`
+
+Then install the dependencies (`npm i` is shorthand for `npm install`):
+
+`npm i`
+
+Once you have completed the above, you can launch a server locally that will build and run the docs locally. In your favorite shell run:
+
+`npm run start`
+
+- Then, go to `http://localhost:3000` and you will see the all contributors website there!
+- Refresh the page as you make changes to the markdown pages in site locally 
 
 ## Add yourself as a contributor