ConfigHubPub / ConfigHubPub/ConfigHubPlatform

Update README or prod docker image for db initialization

Open
#119 3 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
80
Forks
25
PR merge metrics
No merged PRs in 30d

Description

There is a missing step in the README.md for bringing up confighub docker images from Docker Hub: people need to build the confighub db manager and use it to init their db before trying to bring up the docker image and connect to it. This is the "quick solution".

The "better solution" is to have the docker image pull the code, build it, and init the db by itself the first time the confighub docker image comes up.

The "best solution" is to integrate the db manager code into the confighub code. Then the db manager and CH code can be worked upon and built in lock-step, and images can be deployed with all the necessary tools more reasily.

Contributor guide

Open the contributing guide

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.

Research direction

Review README.md and the Docker Hub image startup process to understand the current database initialization steps and the existing db manager. Compare the documented quick solution with the proposed automated and integrated alternatives; clarify which scope is intended before starting. Done should mean users can bring up the image with an initialized database, either through complete instructions or automation.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, javascript
Domain
databases, devops, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.