Skip to content

Commit 3cce6ff

Browse files
committed
replaced by in multiple files
1 parent 45a98fc commit 3cce6ff

12 files changed

Lines changed: 20 additions & 20 deletions

File tree

.github/CONTRIBUTING.md

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

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

11-
- Follow the tutorial in codabench wiki: 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.
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.
1212
- 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

README.md

Lines changed: 1 addition & 1 deletion
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://docs.codabench.org)
12+
- [Codabench Docs](https://docs.codabench.org)
1313

1414

1515
## Quick installation (for Linux)

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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ 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:
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:
7979
[Competition YAML](https://docs.codabench.org/latest/Organizers/Benchmark_Creation/Yaml-Structure/)
8080

8181

documentation/docs/Organizers/Benchmark_Creation/How-to-transition-from-CodaLab-to-Codabench.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,5 +56,5 @@ If you don’t have any previous competition, and want to learn how to create on
5656

5757
## Concluding remarks
5858

59-
Codabench, the new version of the competition and benchmark platform CodaLab, was launched on August 2023 and is already receiving great attention. For users accustomed to CodaLab, the transition to Codabench is quick and easy. Indeed, competition bundles are back-compatible, and all that is required is to create an account on Codabench. To go further, you can refer to [Codabench’s Wiki](https://wiki.codabench.org).
59+
Codabench, the new version of the competition and benchmark platform CodaLab, was launched on August 2023 and is already receiving great attention. For users accustomed to CodaLab, the transition to Codabench is quick and easy. Indeed, competition bundles are back-compatible, and all that is required is to create an account on Codabench. To go further, you can refer to [Codabench’s Docs](https://docs.codabench.org).
6060

documentation/docs/Organizers/Running_a_benchmark/Compute-Worker-Management---Setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ BROKER_USE_SSL=True
4949
```
5050

5151
!!! note
52-
- The broker URL is a unique identifier of the job queue that the worker should listen to. To create a queue or obtain the broker URL of an existing queue, you can refer to [Queue Management](Queue-Management.md) wiki page.
52+
- The broker URL is a unique identifier of the job queue that the worker should listen to. To create a queue or obtain the broker URL of an existing queue, you can refer to [Queue Management](Queue-Management.md) docs page.
5353

5454
- `/codabench` -- this path needs to be volumed into `/codabench` on the worker, as you can see below. You can select another location if convenient.
5555

documentation/docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Documentation
22

3-
Welcome to the Codabench wiki!
3+
Welcome to the Codabench docs!
44

55
Codabench is a platform allowing you to flexibly specify a benchmark. First you define tasks, e.g. datasets and metrics of success, then you specify the API for submissions of code (algorithms), add some documentation pages, and "CLICK!" your benchmark is created, ready to accept submissions of new algorithms. Participant results get appended to an ever-growing leaderboard.
66

@@ -14,7 +14,7 @@ You may also create inverted benchmarks in which the role of datasets and algori
1414
[Compute Worker Setup](Organizers/Running_a_benchmark/Compute-Worker-Management---Setup.md)
1515
[Administrative Procedures](Developers_and_Administrators/Administrator-procedures.md)
1616

17-
!!! tip "Use the top bar or the search functionality to navigate the wiki!"
17+
!!! tip "Use the top bar or the search functionality to navigate the docs!"
1818

1919
## Useful links
2020
[Governance Document](https://github.com/codalab/codalab-competitions/wiki/Community-Governance)

documentation/mkdocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: Codabench Wiki
1+
site_name: Codabench Docs
22
repo_url: https://github.com/codalab/codabench
33
copyright: Apache-2.0
44
edit_uri: edit/develop/documentation/docs
@@ -69,8 +69,8 @@ plugins:
6969
download_link: header
7070
author: Codabench Team
7171
copyright: Apache-2.0
72-
cover_subtitle: Codabench Wiki PDF
73-
output_path: codabench-wiki.pdf
72+
cover_subtitle: Codabench Docs PDF
73+
output_path: codabench-docs.pdf
7474
toc_level: 3
7575

7676
# Version docs (with git)

0 commit comments

Comments
 (0)