pulp / pulp/pulpcore

Configuration file examples in documentation?

Open
#3,889 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation Task
Dominant language
Python
Stars
598
Forks
168
Avg merge
1d 4h
Merged PRs (30d)
86

Description

I found some frustration when setting up the configuration file and choosing something other than py. Is there somewhere that describes the "pulp" section that is used when using toml/yaml/etc? That caught me by surprise. For example, a YAML config file needed:

pulp:
  CONTENT_ORIGIN: xyz

whereas PY only needed:

CONTENT_ORIGIN="xyz"

If we could highlight this requirement in the docs, that should be helpful. Another thing that I found confusing was the "DATABASES" configuration – the information page only describes local databases and has nothing about the structure required for an external connection (which I found after digging around for a while, ending up at the django docs):

DATABASES = {
 "default": {
   "ENGINE": "django.db.backends.postgresql",
   "NAME": "pulp",
   "USER": "pulp",
   "PASSWORD": "...",
   "HOST": "...",
 }
}

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

The issue names no repository files or tests; start by locating the configuration information page and its documentation entry point. Add examples explaining the pulp wrapper for YAML/TOML-style configuration and the external DATABASES structure, using the Django database settings as the reference, then verify both examples are clear and complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, postgresql, python, yaml
Domain
databases, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.