python-poetry / python-poetry/website

Missing official documentation for creating Dockerfiles and CI pipelines

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

Nobody has claimed this yet.

Dominant language
HTML
Stars
39
Forks
21
Avg merge
2h 5m
Merged PRs (30d)
2

Description

I wanted to migrate my pipenv project to poetry. I managed to do this for local setup, however I had troubles configuring my dockerfile, as your website has absolutely no documentation about working with CI and containers (other than installation guide).

I have found this amazing stackoverflow answer: https://stackoverflow.com/a/54763270/17101184 and I'm wondering why this info isn't available in the official documentation. Your documentation describes each configuration flag in detail, but gives no guide for common usage cases, like working in docker (recommending flags like POETRY_VIRTUALENVS_CREATE=false).

Contributor guide

No contributing guide indexed for this repository

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

Start by reviewing the official installation guide and the documentation's configuration-flag pages, then compare them with the linked Stack Overflow answer. Document common Poetry usage for Dockerfiles and CI pipelines, including the relevant virtual-environment setting; done means users can follow an official guide for these workflows.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, python
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.