docker / docker/cli

Should the `Dockerfile` man-page still live in this repository?

Open
#3,970 0 comments 0 reactions 2 assignees View on GitHub

@dvdksn is already working on this.

Since Mar 25, 2024.

area/builder impact/documentation kind/docs kind/enhancement
Dominant language
Go
Stars
6.1k
Forks
2.2k
Avg merge
1d 15h
Merged PRs (30d)
43

Description

Description

I just noticed that this repository still has the Dockerfile man-page, and I was wondering what the best location was for that, because all other reference docs for the Dockerfile was moved to BuildKit and/or Buildx; https://github.com/docker/cli/blob/16466f1ce6b6d27592973c5b94bcc06fa4c88e89/man/Dockerfile.5.md

  • we publish man-pages for docker CLI as part of the .deb and .rpm packages (do we do the same for buildx?)
  • even though most build-related things moved to buildx, the docker CLI still supports build using the classic builder (so having a Dockerfile man-page somewhat make sense in this repo
  • 👎 It's easier to keep both reference and man-page in the same location to prevent them from diverging

/cc @crazy-max @dvdksn any thoughts?

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.