Skip to content

docs: create multiple pathways to find ARG and FROM info#1

Open
ellemenno wants to merge 1 commit intomasterfrom
ellemenno-docs-arg-from
Open

docs: create multiple pathways to find ARG and FROM info#1
ellemenno wants to merge 1 commit intomasterfrom
ellemenno-docs-arg-from

Conversation

@ellemenno
Copy link
Owner

- What I did

help the reader learn of important options and side effects when reading the ARG or Format sections.

looking up ARG in the reference misses all mention of several important facts:

  • ARG values are reset with each FROM
  • reset ARGs can be brought back into scope with an empty declaration
  • ARGs may be used in FROM statements

these facts are well documented under FROM (see Understand how ARG and FROM interact), so this change tries to help the reader find that documentation when starting at ARG or Format.

- How I did it

added notes to the ARG and Format sections

- How to verify it

  • read /reference/builder/#arg
  • read reference/builder/#format

- Description for the changelog

docs: create multiple pathways to find ARG and FROM info

- A picture of a cute animal (not mandatory but encouraged)

ʕ´•ᴥ•`ʔ

looking up `ARG` in the reference misses all mention of several important facts:
- `ARG` values are reset with each `FROM`
- reset `ARG`s can be brought back into scope with an empty declaration
- `ARG`s may be used in `FROM` statements

these facts are well documented under `FROM` ([see _Understand how ARG and FROM interact_](https://docs.docker.com/engine/reference/builder/#understand-how-arg-and-from-interact)), so this change tries to help the reader find that documentation when starting at `ARG` or **Format**.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant