Documentation: missing documentation for certain `dockerTools` functions - Githubissues

NixOS / nixpkgs

Nix Packages collection & NixOS

MIT License

17.98k stars 13.98k forks source link

Documentation: missing documentation for certain `dockerTools` functions #283715

Open DanielSidhion opened 9 months ago

DanielSidhion commented 9 months ago

Problem

The following functions defined in dockerTools aren't documented in the Nixpkgs manual:

buildImageWithNixDb
buildLayeredImageWithNixDb
streamNixShellImage

Proposal

Those functions should be documented so other people can become aware that they exist, and understand how they can/should be used.

Checklist

[x] checked latest Nixpkgs manual (source) and latest NixOS manual (source)
[x] checked open documentation issues for possible duplicates
[x] checked open documentation pull requests for possible solutions

Add a :+1: reaction to issues you find important.

nixos-discourse commented 5 months ago

This issue has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/building-a-ci-docker-image/45665/4