docs: update documentation for contributing guide and container registry #patch (#43)

* 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

* Update README.md

* Update README.md

* Update BUG.yml

* docs: fix clipping issue

* build: 🔧 adjust docker-compose.local to docker-compose.build as it more accurately describes its task

* feat: split things into container dir

* docs: shuffle docs around

* Update beta.yml

* Update publish.yml

* Update README.md

* docs: improve REAMDE

* Update README.md

* Update CONTRIBUTING.md

* docs: remove old examples

* docs: cleanup docs

* Update Dockerfile

* Update Dockerfile

* Update Dockerfile

* docs: more doc examples.

* Update docker-compose.yml

* Update .gitignore

* Update entrypoint.sh

* build(deps): bump anothrNick/github-tag-action from 1.69.0 to 1.70.0 (#24)

Bumps [anothrNick/github-tag-action](https://github.com/anothrnick/github-tag-action) from 1.69.0 to 1.70.0.
- [Release notes](https://github.com/anothrnick/github-tag-action/releases)
- [Commits](anothrNick/github-tag-action@1.69.0...1.70.0)

---
updated-dependencies:
- dependency-name: anothrNick/github-tag-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

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

* docs: 📝 Improved bug report form and added rcon_password example (#26)

* Update BUG.yml

* t

* Update BUG.yml

* Update BUG.yml

* docs: include private sponsors [skip ci]

* chore: Update sponsors 💖 [skip ci]

* docs: update sponsors again [skip ci]

* chore: Update sponsors 💖 [skip ci]

* Update sponsors.yml

* chore: Update sponsors 💖 [skip ci]

* chore: Update sponsors 💖 [skip ci]

* feat: support titles with legacy beta versions, ie valve-legacy, cstrike-legacy and czero-legacy

* fix: properly pass in flags

* fix: adjust how flags are passed in

* build: 🔧 Rename FLAGS -> FLAG to mirror GAME

* fix: pass in correct game name

* docs: remove build: docker as its not needed

* build(startup): 🔧 Setup initial build debug scripts

* build: add meta data for image

* fix: adjust ordering of ascii art

* chore: adjust default startup to use hldm

* Squashed commit of the following:

commit 3e3d74c
Author: James Ives <[email protected]>
Date:   Mon Sep 9 09:48:14 2024 -0400

    docs: update bug template #minor

* chore: Update sponsors 💖 [skip ci]

* fix: recursively push files (#34)

* Fix: Ensure existing files are updated accordingly. (#36)

* docs: update README for container registry (#40)

* docs: update contributing file (#41)

---------

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]>

Author: JamesIves

CONTRIBUTING.md

@@ -19,4 +19,4 @@ The four main requirements for this project are:
 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.
+7. After some more tests, changes will be merged into the `main` branch where the production images will be published. This step will be performed by a project maintainer.

README.md

@@ -45,7 +45,7 @@ docker run -d \
 > - `jives/hlds:cstrike-legacy` ([Counter-Strike](https://store.steampowered.com/app/10/CounterStrike/)) ([Pre-25th Anniversary Build](https://www.half-life.com/en/halflife25))
 > - `jives/hlds:czero-legacy` ([Counter-Strike Condition Zero](https://store.steampowered.com/app/80/CounterStrike_Condition_Zero/)) ([Pre-25th Anniversary Build](https://www.half-life.com/en/halflife25))
 >
-> Container images are alternatively available on the [GitHub Container Registry](https://github.com/JamesIves/hlds-docker/pkgs/container/hlds).
+> Container images are published on [Docker Hub](https://hub.docker.com/repository/docker/jives/hlds/general) and the [GitHub Container Registry](https://github.com/JamesIves/hlds-docker/pkgs/container/hlds).
 
 Once the command finishes, you can connect to your server via the public IP address by loading the game on [Steam](https://steampowered.com). **You must own a copy of the game on Steam to play**.