Fix #4758: Add comprehensive documentation for adding/removing challenge hosts and participants
Fixes #4758
Overview
This PR improves the EvalAI documentation by adding clear and structured guides for managing challenge hosts and participant teams. These updates help both new contributors and challenge organizers understand how to add/remove hosts and challenge participants through the Web UI and API.
Changes Introduced
1. Challenge Host Management Documentation
- Added new page:
challenge-host-management.mdunder02-for-challenge-hosts/hosting-guide/ - Includes detailed instructions for:
- Adding a challenge host
- Removing a challenge host
- Managing hosts using Web UI and REST API
2. Updates to Navigation Index
- Updated
02-for-challenge-hosts/hosting-guide/index.mdto include the new documentation page.
3. Participant Team Management Improvements
- Updated
03-for-participants/participation-guide/team-management.mdwith enhanced formatting and clearer explanations.
Testing
- Built Sphinx docs locally using
make html - Verified all new pages render properly
- Navigation links appear correctly in the sidebar
- Confirmed no broken links or warnings during build
Additional Notes
- No backend or frontend code changes.
- Pure documentation improvements only.
Codecov Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 91.90%. Comparing base (d4ce4fa) to head (cdef011).
Additional details and impacted files
@@ Coverage Diff @@
## master #4816 +/- ##
==========================================
+ Coverage 91.89% 91.90% +0.01%
==========================================
Files 86 86
Lines 7132 7132
==========================================
+ Hits 6554 6555 +1
+ Misses 578 577 -1
| Flag | Coverage Δ | |
|---|---|---|
| backend | 96.67% <ø> (ø) |
|
| frontend | 87.17% <ø> (+0.02%) |
:arrow_up: |
Flags with carried forward coverage won't be shown. Click here to find out more.
| Components | Coverage Δ | |
|---|---|---|
| Accounts & Authentication | 100.00% <ø> (ø) |
|
| Challenges Management | 95.39% <ø> (ø) |
|
| Job Processing | 98.19% <ø> (ø) |
|
| Participants & Teams | 100.00% <ø> (ø) |
|
| Challenge Hosts | 100.00% <ø> (ø) |
|
| Analytics | 100.00% <ø> (ø) |
|
| Web Interface | 100.00% <ø> (ø) |
|
| Frontend (Gulp) | 87.17% <ø> (+0.02%) |
:arrow_up: |
| All Models | 97.58% <ø> (ø) |
|
| All Views | 100.00% <ø> (ø) |
|
| All Serializers | 98.82% <ø> (ø) |
|
| Utility Functions | 96.82% <ø> (ø) |
|
| Core Configuration | 82.35% <ø> (ø) |
|
| see 1 file with indirect coverage changes | ||
| see 1 file with indirect coverage changes |
Continue to review full report in Codecov by Sentry.
Legend - Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing dataPowered by Codecov. Last update d4ce4fa...cdef011. Read the comment docs.
:rocket: New features to boost your workflow:
- :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.