Skip to content

Commit 3036a5a

Browse files
authored
Merge pull request #2080 from codalab/wikiMigration
Change old wiki link to docs.codabench.org links
2 parents 492316f + 3cce6ff commit 3036a5a

27 files changed

Lines changed: 79 additions & 80 deletions

.github/CONTRIBUTING.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,20 @@
33
## 1. Being a Codabench user.
44

55
- Create a user account on https://codalab.lisn.fr and on https://codabench.org.
6-
- Register on https://codabench.org to this existing competition (IRIS-tuto) https://www.codabench.org/competitions/1115/ and make a submission (from https://github.com/codalab/competition-examples/tree/master/codabench/iris): sample_result_submission and sample_code_submission. See https://github.com/codalab/codabench/wiki/User_Participating-in-a-Competition
7-
- Create your own private competition (from https://github.com/codalab/competition-examples/tree/master/codabench/ ). See https://github.com/codalab/codabench/wiki/Getting-started-with-Codabench
6+
- Register on https://codabench.org to this existing competition (IRIS-tuto) https://www.codabench.org/competitions/1115/ and make a submission (from https://github.com/codalab/competition-examples/tree/master/codabench/iris): sample_result_submission and sample_code_submission. See https://docs.codabench.org/latest/Participants/User_Participating-in-a-Competition/
7+
- Create your own private competition (from https://github.com/codalab/competition-examples/tree/master/codabench/ ). See https://docs.codabench.org/latest/Organizers/Benchmark_Creation/Getting-started-with-Codabench/
88

99
## 2. Setting a local instance of Codabench.
1010

11-
- Follow the tutorial in codabench wiki: https://github.com/codalab/codabench/wiki/Codabench-Installation. 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.
12-
- If needed, you can also look into https://github.com/codalab/codabench/wiki/How-to-deploy-Codabench-on-your-server
11+
- Follow the tutorial in codabench docs: https://docs.codabench.org/latest/Developers_and_Administrators/Codabench-Installation/. 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.
12+
- If needed, you can also look into https://docs.codabench.org/latest/Developers_and_Administrators/How-to-deploy-Codabench-on-your-server/
1313

1414
## 3. Using one's local instance
1515

1616
- Create your own competition and play with it. You can look at the output logs of each different docker container.
17-
- Setting you as an admin of your platform (https://github.com/codalab/codabench/wiki/Administrator-procedures#give-superuser-privileges-to-an-user) and visit the Django Admin menu: https://github.com/codalab/codabench/wiki/Administrator-procedures#give-superuser-privileges-to-an-user
18-
17+
- Setting you as an admin of your platform (https://docs.codabench.org/latest/Developers_and_Administrators/Administrator-procedures/#give-superuser-privileges-to-a-user) and visit the Django Admin menu: https://docs.codabench.org/latest/Developers_and_Administrators/Administrator-procedures/#give-superuser-privileges-to-a-user
1918
## 4. Setting an autonomous computer-worker on your PC
2019

21-
- Configure and launch the docker container: https://github.com/codalab/codabench/wiki/Compute-Worker-Management---Setup
22-
- Create a private queue on your new own competition on the production server codabench.org: https://github.com/codalab/codabench/wiki/Queue-Management#create-queue
20+
- Configure and launch the docker container: https://docs.codabench.org/latest/Organizers/Running_a_benchmark/Compute-Worker-Management---Setup/
21+
- Create a private queue on your new own competition on the production server codabench.org: https://docs.codabench.org/latest/Organizers/Running_a_benchmark/Queue-Management/#create-queue
2322
- Assign your own compute-worker to this private queue instead of the default queue.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To see Codabench in action, visit [codabench.org](https://www.codabench.org/).
99

1010
## Documentation
1111

12-
- [Codabench Wiki](https://github.com/codalab/codabench/wiki)
12+
- [Codabench Docs](https://docs.codabench.org)
1313

1414

1515
## Quick installation (for Linux)
@@ -30,7 +30,7 @@ You can now login as username "admin" with password "admin" at http://localhost/
3030

3131
If you ever need to reset the database, use the script `./reset_db.sh`
3232

33-
For more information about installation, checkout [Codabench Basic Installation Guide](https://github.com/codalab/codabench/wiki/Codabench-Installation) and [How to Deploy Server](https://github.com/codalab/codabench/wiki/How-to-deploy-Codabench-on-your-server).
33+
For more information about installation, checkout [Codabench Basic Installation Guide](https://docs.codabench.org/latest/Developers_and_Administrators/Codabench-Installation/) and [How to Deploy Server](https://docs.codabench.org/latest/Developers_and_Administrators/How-to-deploy-Codabench-on-your-server/).
3434

3535

3636
## License

docs/example_scripts/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ These scripts have been built solely to improve users' understanding of the API
44
and expressly not as utility scripts. They can serve as starting places, but they
55
ought not be solely relied upon for automation.
66

7-
They exist here for easy testing of robot submissions outlined [here](https://github.com/codalab/competitions-v2/wiki/Robot-submissions).
7+
They exist here for easy testing of robot submissions outlined [here](https://docs.codabench.org/latest/Developers_and_Administrators/Robot-submissions/).

documentation/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ Welcome to the Codabench Documentation.
33

44
You can access the documentation generated from this folder [here](https://codalab.org/codabench/latest/)
55

6-
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.
6+
If you want to contribute to the docs, 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.
77

88

9-
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)
9+
When creating a Pull Request to modify the core code of Codabench, you can also include the docs modification by modifying the relevant files. Once the Pull Request is merged, the docs will automatically be updated with your changes (`dev` tag when it's merged into develop, and the `latest` version of the docs once it's merged in master)
1010

1111
## How to build
12-
To build the wiki locally, you will have to first install [uv](https://github.com/astral-sh/uv)
12+
To build the docs locally, you will have to first install [uv](https://github.com/astral-sh/uv)
1313

1414
Once that is done, you can run the following commands (while inside this folder):
1515

@@ -18,12 +18,12 @@ uv sync # You only need to run this once, it will download all the necessary pyt
1818
PDF=1 uv run mkdocs serve -a localhost:8888 # This will build the site and serve it on localhost:8888
1919
```
2020

21-
Open [localhost:8888](http://localhost:8888/) in your browser and you will see the wiki. Every changes you make will rebuild the documentation.
21+
Open [localhost:8888](http://localhost:8888/) in your browser and you will see the docs. Every changes you make will rebuild the documentation.
2222
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.
2323

2424

2525
### Versioning
26-
We use the [mike](https://github.com/jimporter/mike) plugin to preserve multiple version of the wiki.
26+
We use the [mike](https://github.com/jimporter/mike) plugin to preserve multiple version of the docs.
2727

2828
To use it, you can run the following command:
2929
```bash
@@ -36,4 +36,4 @@ Check the official Github page of the plugin for more information on how it work
3636
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.
3737

3838
## Github workflow
39-
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.
39+
We have Github workflows set up to automatically rebuild the docs when the `develop` branch receives changes, and when a new tag is created for the `master` branch.

documentation/docs/Contribute/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Setting up a local instance of Codabench
88

9-
- 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.
9+
- Follow the tutorial in codabench [Docs](../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.
1010
- 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)
1111

1212
### Using your local instance

documentation/docs/Newsletters_Archive/CodaLab-in-2024.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Contributors community is very active with **143 pull requests** this year. Sinc
1919
## Introducing Codabench
2020
[Codabench](https://codabench.org/), the modernized version of [CodaLab](https://codalab.lisn.fr/), was released in summer 2023, and [presented at JCAD days](https://www.canal-u.tv/chaines/jcad/codalab-competitions-and-codabench-open-source-platforms-to-organize-scientific) in November 2024! Codabench platform software is now concentrating all development effort of the community. In addition to CodaLab features, it offers improved performance, live logs, more transparency, data-centric benchmarks and more!
2121

22-
We warmly encourage you to use [codabench.org](https://codabench.org/) for all your new competitions and benchmarks. Note that CodaLab bundles are compatible with Codabench, easing the transition, as explained in the following Wiki page: [How to transition from CodaLab to Codabench](../Organizers/Benchmark_Creation/How-to-transition-from-CodaLab-to-Codabench.md)
22+
We warmly encourage you to use [codabench.org](https://codabench.org/) for all your new competitions and benchmarks. Note that CodaLab bundles are compatible with Codabench, easing the transition, as explained in the following docs page: [How to transition from CodaLab to Codabench](../Organizers/Benchmark_Creation/How-to-transition-from-CodaLab-to-Codabench.md)
2323

2424
CodaLab and Codabench are hosted on servers located at [Paris-Saclay university](https://www.universite-paris-saclay.fr/), maintained by [LISN lab](http://lisn.upsaclay.fr/).
2525

documentation/docs/Organizers/Benchmark_Creation/Competition-Bundle-Structure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ leaderboard:
7575
7676
7777
## Competition YAML
78-
The `competition.yaml` file is the most important file in the bundle. It's what Codabench looks for to figure out the structure and layout of your competition, along with additional details. For more information on setting up a `competition.yaml` see the wiki page here:
79-
[Competition YAML](https://github.com/codalab/competitions-v2/wiki/Yaml-Structure)
78+
The `competition.yaml` file is the most important file in the bundle. It's what Codabench looks for to figure out the structure and layout of your competition, along with additional details. For more information on setting up a `competition.yaml` see the docs page here:
79+
[Competition YAML](https://docs.codabench.org/latest/Organizers/Benchmark_Creation/Yaml-Structure/)
8080

8181

8282
## Data Types And Their Role:

documentation/docs/Organizers/Benchmark_Creation/Competition-Creation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ Competition creation can be done two ways. Through the online form on Codalab, o
33
## Bundle Upload
44
For more information on Bundle Upload see here:
55

6-
[Competition Creation: Bundle](https://github.com/codalab/competitions-v2/wiki/Competition-Creation:-Bundle)
6+
[Competition Creation: Bundle](https://docs.codabench.org/latest/Organizers/Benchmark_Creation/Competition-Creation%3A-Bundle/)
77

88
For more information on Competition Bundle Structure, see here:
99

10-
[Competition Bundle Structure](https://github.com/codalab/competitions-v2/wiki/Competition-Bundle-Structure)
10+
[Competition Bundle Structure](https://docs.codabench.org/latest/Organizers/Benchmark_Creation/Competition-Bundle-Structure/)
1111

1212
## GUI creation
1313
For more information on GUI creation see here:
1414

15-
[Competition Creation: Form](https://github.com/codalab/competitions-v2/wiki/Competition-Creation:-Form)
15+
[Competition Creation: Form](https://docs.codabench.org/latest/Organizers/Benchmark_Creation/Competition-Creation%3A-Form/)
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This page is relatively simple. It's where you submit a completed competition bundle to Codabench, in order for it to be processed into a competition instance. For more information on competition bundles, see this link here: [Competition Bundle Structure](https://github.com/codalab/competitions-v2/wiki/Competition-Bundle-Structure).
1+
This page is relatively simple. It's where you submit a completed competition bundle to Codabench, in order for it to be processed into a competition instance. For more information on competition bundles, see this link here: [Competition Bundle Structure](https://docs.codabench.org/latest/Organizers/Benchmark_Creation/Competition-Bundle-Structure/).
22

33
![image](../../_attachments/71213494-82863c80-2268-11ea-8efc-27c51795a23e_17528513091588552.png)
44

@@ -8,4 +8,4 @@ To begin, just click the paper clip icon, or the bar next to it. It should open
88

99
## Backward compatibility
1010

11-
If you previously used [CodaLab Competitions](https://github.com/codalab/codalab-competitions), note that Codabench is compatible with CodaLab bundles.
11+
If you previously used [CodaLab Competitions](https://github.com/codalab/codalab-competitions), note that Codabench is compatible with CodaLab bundles.

documentation/docs/Organizers/Benchmark_Creation/Dataset-competition-creation-and-participate-instruction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This page focuses on how to create a dataset contest via bundle and make submiss
55
The brief process can be summarized in the following diagram![](../../_attachments/0_17528513120435548.png)
66

77
There are two main parts:
8-
- the contest organizer creates the dataset competition by uploading a bundle (For more information on how to create a contest via bundle, and the definition of bundle, you can refer to this link [Competition-Creation:-Bundle](https://github.com/codalab/competitions-v2/wiki/Competition-Creation:-Bundle))
8+
- the contest organizer creates the dataset competition by uploading a bundle (For more information on how to create a contest via bundle, and the definition of bundle, you can refer to this link [Competition-Creation:-Bundle](https://docs.codabench.org/latest/Organizers/Benchmark_Creation/Competition-Creation%3A-Bundle/))
99

1010
- Competition participant submission dataset
1111

0 commit comments

Comments
 (0)