docs: 📝 Improve overall documentation structure (#22)

* build: add auto-labeler and sponsors information (#17)

* Update README.md

* Create sponsors.yml

* Create label.yml

* test: resolve issue thing

* style: remove typo

* chore: update

* build(deps): bump softprops/action-gh-release from 1 to 2 (#18)

Bumps [softprops/action-gh-release](https://github.com/softprops/action-gh-release) from 1 to 2.
- [Release notes](https://github.com/softprops/action-gh-release/releases)
- [Changelog](https://github.com/softprops/action-gh-release/blob/master/CHANGELOG.md)
- [Commits](softprops/action-gh-release@v1...v2)

---
updated-dependencies:
- dependency-name: softprops/action-gh-release
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* build(deps): bump actions/checkout from 3 to 4 (#19)

Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* docs: 📝 Improve documentation (#21)

* docs: docker whale image

* Update README.md

* Update README.md

* Update README.md

* docs: add more examples

* docs: add more examples

* docs: improve docs

* Update README.md

* Update README.md

* Update README.md

* test

* Update BUILDING_AN_IMAGE.md

* Update label.yml

* Delete crowbar.png

* Update README.md

* Update sponsors.yml

* docs: more doc improvements/spell checks etc

* Deploying to beta from @ ee94d7c 🚀

* Update sponsors.yml

* Update README.md

* docs: server -> joinable not error

* Update CUSTOM_MODS.md

* Update SERVER_CONFIGS_AND_PLUGINS.md

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: JamesIves <[email protected]>

.github/workflows/label.yml

@@ -0,0 +1,95 @@
+name: Label Pull Requests 🏷️
+
+on:
+  pull_request:
+    types: [opened, reopened, labeled, unlabeled, synchronize]
+
+permissions:
+  pull-requests: write
+  contents: read
+
+jobs:
+  assign-labels:
+    runs-on: ubuntu-latest
+    name: Assign labels in pull request 🏷️
+    if: github.event.pull_request.merged == false
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+
+      - name: Assign Labels 🏷️
+        id: action-assign-labels
+        uses: mauroalderete/action-assign-labels@v1
+        with:
+          pull-request-number: ${{ github.event.pull_request.number }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          conventional-commits: |
+            conventional-commits:
+              - type: 'fix'
+                nouns: ['FIX', 'Fix', 'fix', 'FIXED', 'Fixed', 'fixed']
+                labels: ['bug 🐝', 'fix 🐝']
+              - type: 'feature'
+                nouns: ['FEATURE', 'Feature', 'feature', 'FEAT', 'Feat', 'feat']
+                labels: ['feature ✨']
+              - type: 'breaking_change'
+                nouns: ['BREAKING CHANGE', 'BREAKING', 'MAJOR']
+                labels: ['breaking 💥']
+              - type: 'documentation'
+                nouns: ['doc', 'docu', 'docs', 'document', 'documentation']
+                labels: ['documentation 📖']
+              - type: 'build'
+                nouns: ['build', 'rebuild']
+                labels: ['build 🔧']
+              - type: 'chore'
+                nouns: ['chore', 'tidy', 'cleanup']
+                labels: ['chore 🧹']
+              - type: 'dependencies'
+                nouns: ['dependency', 'dependencies', 'package', 'packages', 'bump', 'dependabot']
+                labels: ['dependencies 🤖']
+              - type: 'duplicate'
+                nouns: ['duplicate', 'dupe', 'copy']
+                labels: ['duplicate 2️⃣']
+              - type: 'good_first_issue'
+                nouns: ['good first issue', 'beginner', 'newcomer', 'first-timer']
+                labels: ['good first issue 🍩']
+              - type: 'help_wanted'
+                nouns: ['help wanted', 'need help', 'assistance required']
+                labels: ['help wanted ❕']
+              - type: 'proposal'
+                nouns: ['proposal', 'suggest', 'suggestion']
+                labels: ['proposal 🔮']
+              - type: 'question'
+                nouns: ['question', 'inquiry', 'query']
+                labels: ['question ❓']
+              - type: 'test'
+                nouns: ['test', 'testing', 'tests']
+                labels: ['test 🧪']
+              - type: 'triage'
+                nouns: ['triage', 'sort', 'prioritize']
+                labels: ['triage ⚠️']
+              - type: 'wontfix'
+                nouns: ['wontfix', 'will not fix', 'not fixing']
+                labels: ['wontfix 🔨']
+              - type: 'style'
+                nouns: ['style', 'formatting', 'format']
+                labels: ['style 🎀']
+              - type: 'security'
+                nouns: ['security', 'secure', 'safety']
+                labels: ['security 🔒']
+              - type: 'performance'
+                nouns: ['performance', 'speed', 'optimization']
+                labels: ['performance 🚀']
+              - type: 'refactor'
+                nouns: ['refactor', 'refactoring', 'rework']
+                labels: ['refactor 🛠']
+              - type: 'release'
+                nouns: ['release', 'deploy', 'deployment']
+                labels: ['release 🚀']
+              - type: 'ci'
+                nouns: ['ci', 'continuous integration', 'CI/CD']
+                labels: ['ci 🚀']
+              - type: 'hacktoberfest'
+                nouns: ['hacktoberfest', 'october', 'open source']
+                labels: ['hacktoberfest 🎃']
+          maintain-labels-not-matched: false
+          apply-changes: true

.github/workflows/publish.yml

@@ -111,7 +111,7 @@ jobs:
       - name: Create Release 🚀
         id: create_release
         if: github.ref == 'refs/heads/main'
-        uses: softprops/action-gh-release@v1
+        uses: softprops/action-gh-release@v2
         with:
           tag_name: ${{ steps.create_tag.outputs.new_tag }}
           name: ${{ steps.create_tag.outputs.new_tag }}

.github/workflows/sponsors.yml

@@ -0,0 +1,29 @@
+name: Publish Sponsors 💖
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: 30 15 * * 0-6
+permissions:
+  contents: write
+jobs:
+  generate-sponsors:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+
+      - name: Generate Sponsors 💖
+        uses: JamesIves/github-sponsors-readme-action@v1
+        with:
+          token: ${{ secrets.PAT }}
+          file: "README.md"
+          template: '<a href="https://github.com/{{{ login }}}"><img src="https://github.com/{{{ login }}}.png" width="25px" alt="{{{ login }}}" /></a>&nbsp;&nbsp;'
+          active-only: false
+
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: beta
+          folder: "."
+          commit-message: "chore: Update sponsors 💖 [skip ci]"

CONTRIBUTING.md

@@ -1,8 +1,8 @@
-# Contributing ✨
+# Contributing
 
 I appreciate your interest in contributing to this project. Please review the general process and scope before starting a contribution.
 
-## Scope 🔍
+## Scope
 
 The four main requirements for this project are:
 
@@ -11,12 +11,12 @@ The four main requirements for this project are:
 3. Have the ability to run servers for custom mods.
 4. Only support legal usage of Steam and Valve's titles. **It will not, and never will, support the ability to circumvent any licensing or other restrictions Valve imposes.** The project maintainers will report any shady behaviour to Valve and GitHub.
 
-## Process ✈️
+## Process
 
 1. File an issue on the [Issues board](https://github.com/JamesIves/hlds-docker/issues), or create a discussion on the [Discussions board](https://github.com/JamesIves/hlds-docker/discussions).
 2. Once discussed and agreed upon, clone the project.
 3. Make your changes.
-4. Validate your changes; at the very least, please build the image and start a server.
+4. Validate your changes; at the very least, please build the image and start a server. [You can learn how to build the images using the guide located here](docs/BUILDING_AN_IMAGE.md).
 5. Submit a pull request to the `beta` branch.
 6. Once reviewed, your changes will be made available on DockerHub via the `-beta` tag, for example `jives/hlds:cstrike-beta`.
 7. After some more tests, changes will be made sent to the `main` branch where the production images will be published.