Document the different ways to run the project
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Go
- Stars
- 912
- Forks
- 74
- PR merge metrics
- No merged PRs in 30d
Description
There are multiple different ways to run the project
- From the command line
- Using docker-compose
- In production, using the scheduler
It would be nice to have a central document describing how to build and run the project in all these different ways
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 locating the existing instructions and entry points for running the project from the command line, with docker-compose, and through the production scheduler. Create one central document covering how to build and run each mode, with enough detail for a newcomer to follow every path successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker-compose
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100