Improve Development Documentation

[GabLeRoux]

This pull request includes significant updates to the documentation, particularly enhancing the DEVELOPMENT.md guide and the README.md file. The changes aim to provide clearer instructions and a more comprehensive overview of the project's setup, deployment, and functionality.

Documentation Enhancements:

• Development Guide:

  • Renamed the file from # Development to # Development Guide and added a detailed table of contents.
  • Expanded sections on setting up the development environment, including installing Firebase CLI, project dependencies, and running the project locally.
  • Added detailed instructions for deploying the project to Firebase, including logging in and deploying specific services.
  • Included optional setup for Firebase Admin SDK with environment variable configuration for Linux/MacOS and Windows.
  • Provided a thorough guide on setting up integrations and environment variables for Discord and GitHub.
  • Added sections on updating configuration variables in Firebase and troubleshooting tips.

• README Overview:

  • Added an overview of the GameCI Versioning Backend, explaining its purpose and integration with GitHub and Discord.
  • Detailed the backend's functionality for ingesting Unity versions and GameCI Docker versions, including scraping Unity's version archive and scheduling CI build jobs.
  • Explained the scheduler's role in managing CI jobs and builds, including status tracking and notifications.
  • Provided instructions for backing up and restoring the Firestore database using the backfire tool.
  • Linked to the updated DEVELOPMENT.md for further development instructions.

---

I went forward and tried to improve the docs. I wrote this after seing a user mentionning they couldn't find the docs on how to work with this project after looking at the readme. There is now a link to DEVELOPMENT.md at the end of the ReadMe.

You can see the results here:

• DEVELOPMENT.md
• README.md

[davidmfinol]

This is actually great as a refresher for me too

[GabLeRoux]

I found it weird to have dots in these values, but this is probably going to break things. 🤔 Is this a special syntax for firebase functions configuration?

I would appreciate if someone could confirm this one so we can go forward with merging the rest of it 🙏

[GabLeRoux]

I think I pretty much confirmed this by reading the code.

functions/src/api/testFunction.ts
12:const internalToken = defineSecret('INTERNAL_TOKEN');

functions/src/api/reportNewBuild.ts
14:const internalToken = defineSecret('INTERNAL_TOKEN');

functions/src/api/reportPublication.ts
12:const internalToken = defineSecret('INTERNAL_TOKEN');

functions/src/api/reportBuildFailure.ts
11:const internalToken = defineSecret('INTERNAL_TOKEN');

DEVELOPMENT.md
147:export INTERNAL_TOKEN="your_internal_token"

I'm quite sure the syntax when working locally with export is to use INTERNAL_TOKEN instead of internal.token.

[GabLeRoux]

I'm not sure if this will work, but working with firebase emulators is most likely a good approach to working locally with this project. Feedback would be appreciated here.

[webbertakken]

The thing is that in order to create a proper dev workflow you'd have to mock the dispatching github actions (for the building of images) from the cronjob, or skip the cronjob altogether (at which point the emulators don't do much at all).

[GabLeRoux]

I added some comments which I forgot to hit submit as a self review. I would appreciate if someone can give it a try and confirm if the commands are ok. I will give it a try too shortly