Added mkdocs based documentation files for the new wiki

.github/workflows/ghPages-dev.yml

@@ -0,0 +1,25 @@
+name: github-pages-dev 
+on:
+  push:
+    branches:
+      - develop
+permissions:
+  contents: write
+jobs:
+  deploy-dev:
+    runs-on: ubuntu-latest
+    defaults:
+        run:
+            working-directory: documentation/
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - run: /home/runner/.local/bin/uv sync 
+      - run: git fetch origin gh-pages --depth=1 && PDF=1 /home/runner/.local/bin/uv run mike deploy -u dev --push

.github/workflows/ghPages-prod.yml

@@ -0,0 +1,25 @@
+name: github-pages-prod
+on:
+  push:
+    tags:
+      - '*'
+permissions:
+  contents: write
+jobs:
+  deploy-prod:
+    runs-on: ubuntu-latest
+    defaults:
+        run:
+            working-directory: documentation/
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: curl -LsSf https://astral.sh/uv/install.sh | sh
+      - run: /home/runner/.local/bin/uv sync 
+      - run: git fetch origin gh-pages --depth=1 && PDF=1 /home/runner/.local/bin/uv run mike deploy -u  ${{ github.ref_name }} latest --push

documentation/.gitignore

@@ -0,0 +1,14 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+.cache/
+# Virtual environments
+.venv
+
+uv.lock
+
+site/*

documentation/.python-version

@@ -0,0 +1 @@
+3.12

documentation/README.md

@@ -0,0 +1,39 @@
+## Codabench Documentation
+Welcome to the Codabench Documentation.
+
+You can access the documentation generated from this folder [here](https://codalab.org/codabench/latest/)
+
+If you want to contribute to the wiki, you can create a Pull Request modifying the files you want (located in `docs/`) while adding a quick explanation on what you have changed and why.
+
+
+When creating a Pull Request to modify the core code of Codabench, you can also include the wiki modification by modifying the relevant files. Once the Pull Request is merged, the wiki will automatically be updated with your changes (`dev` tag when it's merged into develop, and the `latest` version of the wiki once it's merged in master)
+
+## How to build
+To build the wiki locally, you will have to first install [uv](https://github.com/astral-sh/uv)
+
+Once that is done, you can run the following commands (while inside this folder):
+
+```bash
+uv sync # You only need to run this once, it will download all the necessary python packages
+PDF=1 uv run mkdocs serve -a localhost:8888 # This will build the site and serve it on localhost:8888
+```
+
+Open [localhost:8888](http://localhost:8888/) in your browser and you will see the wiki. Every changes you make will rebuild the documentation.
+You can remove the `PDF=1` environement variable if you want to speed up the build process, but you will not generate the related PDF.
+
+
+### Versioning
+We use the [mike](https://github.com/jimporter/mike) plugin to preserve multiple version of the wiki.
+
+To use it, you can run the following command: 
+```bash
+PDF=1 uv run mike deploy -u dev # This will create the site and push the changes in the gh-pages branch
+uv run mike serve -a localhost:8888 # Serve the site on localhost:8888
+```
+Check the official Github page of the plugin for more information on how it works.
+
+## Images and Assets
+Images and assets are saved in the `_attachments` folder closest to the documentation file that calls for the image. If an image is used in multiple different places, then it should be put in `_attachements` folder in the `docs/` root directory.
+
+## Github workflow
+We have Github workflows set up to automatically rebuild the wiki when the `develop` branch receives changes, and when a new tag is created for the `master` branch.

documentation/docs/Contribute/contributing.md

@@ -0,0 +1,21 @@
+## Being a Codabench user
+
+- Create a user account on [Codabench](https://codabench.org)
+- Register on [Codabench](https://codabench.org) to this existing competition [IRIS-tuto](https://www.codabench.org/competitions/1115/)  and make a submission (you can find the necessary files [here](https://github.com/codalab/competition-examples/tree/master/codabench/iris)): `sample_result_submission` and `sample_code_submission`. See [this page](../Participants/User_Participating-in-a-Competition.md) for more information.
+- Create your own private competition (you can find the necessary files [here](https://github.com/codalab/competition-examples/tree/master/codabench/) ). See [this page](../Organizers/Benchmark_Creation/Getting-started-with-Codabench.md) for more information.
+
+## Setting up a local instance of Codabench
+
+- Follow the tutorial in codabench [wiki](../Developers_and_Administrators/Codabench-Installation.md). According to your hosting OS, you might have to tune your environment file a bit. Try without enabling the SSL protocol (doing so, you don't need a domain name for the server). Try using the embedded Minio storage solution instead of a private cloud storage.
+- If needed, you can also look into [How to deploy Codabench on your server](../Developers_and_Administrators/How-to-deploy-Codabench-on-your-server.md)
+
+### Using your local instance
+
+- Create your own competition and play with it. You can look at the output logs of each different docker container.
+- Setting you as an [admin](../Developers_and_Administrators/Administrator-procedures.md#give-superuser-privileges-to-a-user) of your platform and visit the Django Admin menu.
+
+## Setting up an autonomous Compute Worker on a machine
+
+- Configure and launch a [compute worker](../Organizers/Running_a_benchmark/Compute-Worker-Management---Setup.md) docker container.
+- Create a private [Queue](../Organizers/Running_a_benchmark/Queue-Management.md#create-queue) on your new own competition on the production server codabench.org
+- Assign your own compute-worker to this private queue instead of the default queue.

documentation/docs/Contribute/index.md

@@ -0,0 +1,6 @@
+- Use [Codabench](https://codabench.org/) by either participating in a competition or hosting a new competition.
+- Find a bug? Got a feature request? Submit a [GitHub issue](https://github.com/codalab/codalab/issues?state=open).
+- [P1 issues](https://github.com/codalab/codabench/issues?q=is%3Aissue+is%3Aopen+label%3AP1) are the most important ones.
+- Submit pull requests on GitHub to implement new features or fix bugs (see [the contributing section](contributing.md)).
+- Improve this documentation.
+- Let others know about Codabench!

documentation/docs/Developers_and_Administrators/Administrator-procedures.md

@@ -0,0 +1,249 @@
+## Maintenance Mode
+You can turn on maintenance mode by creating a `maintenance.on` file in the `maintenance_mode` folder. This will change the front page of the website, showing a customizable page (the `maintenance.html` file in the same folder).
+
+Simply remove the `maintenance_mode/maintenance.on` file to end maintenance mode.
+
+---
+During testing, if you want to update or restart some services (e.g : Django), you should follow the following steps:
+
+```bash
+docker compose stop django
+docker compose rm django ## remove old django container
+docker compose create django ## create new django container with the changes from your development
+docker compose start django
+```
+
+This procedure helps you update changes of your development on Django without having to restart every Codabench container.
+
+## Give superuser privileges to a user
+
+With superuser privileges, the user can edit any benchmark and can access the Django admin interface.
+
+```python
+docker compose exec django ./manage.py shell_plus
+u = User.objects.get(username='<USERNAME>') ## can also use email
+u.is_staff = True
+u.is_superuser = True
+u.save()
+```
+
+## Migration
+
+```bash
+docker compose exec django ./manage.py makemigrations
+docker compose exec django ./manage.py migrate
+```
+
+## Collect static files
+
+```bash
+docker compose exec django ./manage.py collectstatic --noinput
+```
+
+## Delete POSTGRESDB and MINIO :
+!!! warning
+    This will delete all your data !
+
+```bash
+## Begin in codabench root directory
+cd codabench
+```
+
+#### Purge data
+
+```bash
+sudo rm -r var/postgres/*
+sudo rm -r var/minio/*
+```
+
+
+#### See data we are going to purge
+```bash
+ls var
+```
+
+
+#### Restart services and recreate database tables
+
+```bash
+docker compose down
+docker compose up -d
+docker compose exec django ./manage.py migrate
+```
+
+## Feature competitions in home page
+
+There are two ways of setting a competition as featured:
+1. Use Django admin (see below) -> click the competition -> scroll down to is featured filed -> Check/Uncheck it
+2. Use competition ID in the django bash to feature or unfeature a competition
+```python
+docker compose exec django ./manage.py shell_plus
+comp = Competition.objects.get(id=<ID>)  ## replace <ID> with competition id
+comp.is_featured = True  ## set to False if you want to unfeature a competition
+comp.save()
+```
+
+## Shell Based Admin Features
+If you're running your own Codabench instance, there are different ways to interact with the application. Inside the `django` container (`#!bash docker compose exec django bash`) you can use `#!bash python manage.py help` to display all available commands and a brief description. By far the most useful are `createsuperuser` and `shell/shell_plus`. 
+
+
+## Django Admin interface
+
+Once you log in an account with superuser privileges, you have access to the "Django Admin" interface:
+
+![interface access](_attachments/214587579-53b8f79c-dc51-4323-b48d-360dd7b5774f_1753436642870153.png)
+
+From this interface, you can change a user's quota, change their staff and superuser status, change the featured competitions displayed on the homepage, manage user accounts and more.
+
+#### Edit announcement and news
+
+In the Django admin interface, click on `Announcements` or `New posts`:
+
+![](_attachments/de2a053f-c804-4c2a-a7ff-0df189c1d79c_17534366434691174.jpg)
+
+For announcement, only the first announcement is read by the front page. For news, all objects are read as separate news.
+You can create and edit objects using the interface. Write the announcement and news using HTML to format the text, add links, and more:
+
+![](_attachments/38c0d1ce-9b27-44bb-804b-c4eed55613df_17534366434285173.jpg)
+
+
+#### Delete a user
+
+Go to `Users`:
+
+![](_attachments/47b45c3e-13ed-4870-a83d-a25338aeaa39_17534366434936385.jpg)
+
+Select it, select the `Delete selected users` action and click on `Go`:
+
+![](_attachments/c0fdd7ff-0c46-4bae-b9e2-7d4e0b774ec2_17534366434447145.jpg)
+
+
+
+## RabbitMQ Management
+The RabbitMQ management tool allows you to see the status of various queues, virtual hosts, and jobs. By default, you can access it at: `http://<your_codalab_instance>:15672/`. The username/password is your RabbitMQ `.env` settings for username and password. The port is hard-set in `docker-compose.yml` to 15672, but you can always change this if needed. For more information, see:
+https://www.rabbitmq.com/management.html
+
+## Flower Management
+Flower is a web based tool for monitoring and administrating Celery clusters. By default, you can access the Flower web portal at `http://<your_codalab_instance>:5555/`. The username/password is your Flower `.env` settings for username and password. 5555 is the default port, and cannot be changed without editing the `docker-compose.yml` file.
+
+For more information on flower, please visit:
+[https://flower.readthedocs.io/en/latest/](https://flower.readthedocs.io/en/latest/)
+
+## Storage analytics
+#### The interface
+The storage analytics page is accessible at [codabench-url/analytics/](https://www.codabench.org/analytics/) under the storage tab.
+
+![image](../_attachments/5107b308-b445-45a3-91d9-b1fbfb5a1ed9_17528513107704363.jpg)
+
+From this interface, you will have access to various analytics data:
+
+- A Storage usage history chart
+- A Competitions focused storage evolution, distribution and table
+- A Users focused storage evolution, distribution and table
+
+All of those data can be filtered by date range and resolution, and exported as CSVs.
+
+The data displayed in those charts are only calculated from a background analytics task that takes place every Sunday at 02:00 UTC time (value editable in the `src/settings/base.py`).
+
+#### The background task
+
+The analytics task is a celery tasked named `analytics.tasks.create_storage_analytics_snapshot`.
+What it does:
+
+- It scans the database looking for file sizes that are not set or flagged in error
+- Actually measures their size and saves it in the database
+- Aggregate the storage space used by day and by Competition/User (for example every day for the last year for each competition) by looking at the database file size fields
+- For data related to the _Platform Administration_ it measures as well the database backup folder directly from the storage instance.
+- Everything is saved as multiple snapshot in time in each Category table (i.g.: `UserStorageDataPoint`)
+- This tasks also runs a database <-> storage inconsistency check and saves the results in a log file located in the `var/logs/` folder
+
+To manually start the task, you can do the following:
+
+- Start codabench `docker compose up -d`
+- Bash into the django container and start a python console:
+```sh
+docker compose exec django ./manage.py shell_plus
+```
+- Manually start the task:
+```python
+from analytics.tasks import create_storage_analytics_snapshot
+eager_results = create_storage_analytics_snapshot.apply_async()
+```
+- If you check the logs (`docker compose logs -f`) of the app you should see "Task create_storage_analytics_snapshot started" coming from the site_worker container
+- If you have to restart the task, don't worry, it will only compute the size of the files that hasn't been computed yet.
+- Once the task is over you should be able to see the results on the web page
+
+
+## Homepage counters
+
+There is also a daily background task counting users, competitions and submissions, in order to display it on the homepage.
+
+You can manually run it:
+
+```bash
+docker compose exec django ./manage.py shell_plus
+```
+
+```python
+from analytics.tasks import update_home_page_counters
+eager_results = update_home_page_counters.apply_async()
+```
+
+
+## User Quota management
+
+#### Increase user quota
+
+###### Using the Django Shell
+
+```python
+docker-compose exec django ./manage.py shell_plus
+```
+
+```python
+u = User.objects.get(username='<USERNAME>') ## can also use email
+u.quota = u.quota * 3 # We multiply the quota by 3 in this example
+u.save()
+```
+
+###### Using the Django Admin Interface
+- Go to the Django admin page
+- Click user table
+- Select the user for whom you want to increase/decrease quota
+- Update the quota field with new quota (in GB e.g. 15)
+![](_attachments/5c8aae99-0cbb-4ffa-87aa-0e9d3f6fd018_17534366434342587.jpg)
+
+## Codabench Statistics
+You can create two types of codabench statistics: 
+
+- Overall platform statistics for a specified year
+- Overall published competitions statistics
+
+Follow the steps below to create the statistics
+
+#### Start codabench 
+```bash
+docker compose up -d
+```
+#### Bash into the django container and start a python console:
+```bash
+docker compose exec django ./manage.py shell_plus
+```
+
+#### For overall platform statistics
+```python
+from competitions.statistics import create_codabench_statistics
+create_codabench_statistics(year=2024)
+```
+!!! note 
+    - If `year` is not specified, the current year is used by default
+    - A CSV file named `codabench_statistics_2024.csv` is generated in `statistics` folder (for year=2024)
+
+#### For overall published competitions statistics
+```python
+from competitions.statistics import create_codabench_statistics_published_comps
+create_codabench_statistics_published_comps()
+```
+!!! note 
+    A csv file named `codabench_statistics_published_comps.csv` is generated in `statistics folder`
+