Skip to content

docs(dockerfile): merge buildkit syntax with reference docs#2934

Merged
crazy-max merged 1 commit into
moby:masterfrom
crazy-max:docs-merge-syntax
Jul 19, 2022
Merged

docs(dockerfile): merge buildkit syntax with reference docs#2934
crazy-max merged 1 commit into
moby:masterfrom
crazy-max:docs-merge-syntax

Conversation

@crazy-max
Copy link
Copy Markdown
Member

@crazy-max crazy-max commented Jun 27, 2022

follow-up #2902

combine buildkit syntax with reference docs and fix links accordingly in the repo. next follow-up will see how we can split the reference docs and create a changelog so users can have a better understanding of the notable changes.

docs/experimental-syntaxes.md and frontend/dockerfile/docs/experimental.md have been removed. Don't think we need them anymore.

Signed-off-by: CrazyMax crazy-max@users.noreply.github.com

@crazy-max crazy-max force-pushed the docs-merge-syntax branch 2 times, most recently from de17d5b to 4c69cdb Compare June 27, 2022 21:12
@thaJeztah
Copy link
Copy Markdown
Member

docs/experimental-syntaxes.md and frontend/dockerfile/docs/experimental.md have been removed

do you think there may be links to those pages, or were they recently renamed to that? (wondering if we need to keep a stub with a link to the new file)

@crazy-max crazy-max force-pushed the docs-merge-syntax branch from 4c69cdb to 3d45bf6 Compare June 27, 2022 21:57
@crazy-max
Copy link
Copy Markdown
Member Author

do you think there may be links to those pages, or were they recently renamed to that?

these files have not changed for ~2 years and links to them are quite low:

@crazy-max crazy-max force-pushed the docs-merge-syntax branch from 3d45bf6 to 102f9d4 Compare June 29, 2022 12:10
@crazy-max
Copy link
Copy Markdown
Member Author

@thaJeztah You right for syntax.md though, quite referenced across GitHub: https://cs.github.com/?scopeName=All+repos&scope=&q=frontend%2Fdockerfile%2Fdocs%2Fsyntax.md

I have put back the md files and updated the link to the new reference docs.

Comment on lines +831 to +832
## RUN --mount

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are the ones we should look at annotations for (specific css class, e.g.)

Comment thread frontend/dockerfile/docs/reference.md Outdated
Comment thread frontend/dockerfile/docs/reference.md Outdated
Comment thread frontend/dockerfile/docs/reference.md Outdated
Comment thread frontend/dockerfile/docs/reference.md Outdated
Comment on lines +989 to +1009
The command is run with no network access (`lo` is still available, but is
isolated to this process)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps start with "The --network=none option ...."

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the title of the section is self-explanatory no?

Comment thread frontend/dockerfile/docs/reference.md
Comment thread frontend/dockerfile/docs/reference.md Outdated
Comment thread frontend/dockerfile/docs/reference.md Outdated
Comment thread frontend/dockerfile/docs/reference.md
@crazy-max crazy-max force-pushed the docs-merge-syntax branch 2 times, most recently from 15c017f to 9f00474 Compare June 29, 2022 14:59
@crazy-max crazy-max requested a review from thaJeztah June 29, 2022 15:04
@crazy-max
Copy link
Copy Markdown
Member Author

@thaJeztah PTAL, I would like to move on with this one so I can check how it goes with cross links in the release notes on docs repo docker/docs#15110. Thanks!

> The use of `--network=host` is protected by the `network.host` entitlement,
> which needs to be enabled when starting the buildkitd daemon with
> `--allow-insecure-entitlement network.host` flag or in [buildkitd config](https://github.com/moby/buildkit/blob/master/docs/buildkitd.toml.md),
> and for a build request with [`--allow network.host` flag](https://docs.docker.com/engine/reference/commandline/buildx_build/#allow).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we import some of the buildx docs into this repo as a follow-up? Seems strange to me that we don't document entitlements in buildkit.

Comment thread frontend/dockerfile/docs/reference.md Outdated
Comment thread frontend/dockerfile/docs/reference.md Outdated
Comment thread frontend/dockerfile/docs/reference.md Outdated
Comment thread frontend/dockerfile/docs/reference.md Outdated
Comment thread frontend/dockerfile/docs/reference.md Outdated
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max crazy-max force-pushed the docs-merge-syntax branch from df987dc to e7e7e15 Compare July 19, 2022 11:29
@crazy-max crazy-max merged commit 536c3fe into moby:master Jul 19, 2022
@crazy-max crazy-max deleted the docs-merge-syntax branch July 19, 2022 17:31
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.

4 participants