Improve example deployment docs

Open
#20 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
django, docker-compose, python

Research direction

Start by reading the existing deployment and setup documentation, then inspect the Django app’s Celery configuration and any existing Docker or Compose files. Document development and production deployment, including example Compose files; done means both environments and the scheduled/background task requirements are covered. No comments or linked pull requests indicate progress, and the issue has had no recent activity.

Written by the indexing model from the issue text.

Description

documentation enhancement

While CHAOTICA is a typical Django app... it does need some extra functionality as it uses Celery to deal with scheduled and background tasks.

Include some deployment documentation for both dev and production environments including some example docker-compose files?

Dominant language
HTML
Stars
6
Forks
4
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from brainthee/CHAOTICA

All issues in brainthee/CHAOTICA

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.