Hard to get this project up and running for new users
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.3k
- Forks
- 245
- PR merge metrics
- No merged PRs in 30d
Description
- The admin guides at https://oncall.tools/docs/admin_guide.html and https://github.com/linkedin/oncall/blob/master/docs/source/admin_guide.rst have diverged. The first one tells users to navigate to `ops/packer`, which was removed in https://github.com/linkedin/oncall/pull/265/changes/5cd0f0c63eaf383d0fa5e2249043fefa90aeb491
- `README.md` points to the outdated guide (https://github.com/linkedin/oncall?tab=readme-ov-file#oncall--)
- The 'Local machine' development setup (https://github.com/linkedin/oncall?tab=readme-ov-file#local-machine) tells users to install `python-pip python-setuptools mysql-server mysql-client`, which no longer exist on new Debian releases. `python3-pip python3-setuptools mariadb-server mariadb-client` do.
- Is up-to-date in the `Dockerfile`, but that's because Docker container support was added _during_ the Python 3 upgrade (https://github.com/linkedin/oncall/pull/290)
- MySQL 5.7 (https://github.com/linkedin/oncall/blob/master/docker-compose.yml#L19) is extremely outdated. It's unclear whether newer versions and/or MariaDB are supported.
- I want to use this project without Iris, but there is no indication that `IRIS_API_HOST` is optional (https://github.com/linkedin/oncall/blob/master/docker-compose.yml#L11) without looking in the code (https://github.com/linkedin/oncall/blob/9bc2b6874b4bcb20b412b3af7b49b3c200d784c7/src/oncall/app.py#L135)
- It might be unclear to new users what Iris even is, and whether these projects **must** or **may** be used in conjunction.
- This project uses the deprecated `setup.py` instead of `pyproject.toml` (which makes it harder to make a Debian package out of it).
- Python 3.13, and therefore Debian Trixie, are not supported (https://github.com/linkedin/oncall/issues/431#issuecomment-3896252944)
- No supported Python versions are documented.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing README.md with docs/source/admin_guide.rst, then review Dockerfile, docker-compose.yml, src/oncall/app.py, and setup.py. Document the current setup dependencies, database and Iris requirements, supported Python versions, and packaging direction so new users can follow one consistent guide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- debian, docker, mariadb, mysql, python
- Domain
- build-system, devops, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100