Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

build: buildkit section #15958

Merged
merged 5 commits into from Oct 25, 2022
Merged

build: buildkit section #15958

merged 5 commits into from Oct 25, 2022

Conversation

crazy-max
Copy link
Member

@crazy-max crazy-max commented Oct 24, 2022 •
edited

needs moby/buildkit#3220
needs docker/cli#3832

Adds "BuildKit" section describing the BuildKit project the most basic way with cross linking to existing pages. Also adds a "Custom Dockerfile syntax" page reworked from Dockerfile reference documentation.

Following these changes I also merged the "build enhancements", "enabling buildkit" and "creating a dockerfile" pages in build section with proper redirects and cross linking.

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

@netlify
Copy link

netlify bot commented Oct 24, 2022 •
edited

✅ Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 2da2d5e
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/635823e869666f0009c5a563
😎 Deploy Preview https://deploy-preview-15958--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@crazy-max crazy-max force-pushed the buildx-extend branch 3 times, most recently from ff24533 to a192e97 Compare October 24, 2022 13:18
dvdksn
dvdksn reviewed Oct 24, 2022
View reviewed changes
Copy link
Contributor

@dvdksn dvdksn left a comment

Choose a reason for hiding this comment

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

This addition, and especially the LLB description, is so damn good I am gonna print it, frame it, and put it on a wall. I have some rephrasing suggestions, that's all.

build/extend/dockerfile-frontend.md Outdated Show resolved Hide resolved
build/extend/dockerfile-frontend.md Outdated Show resolved Hide resolved
build/extend/dockerfile-frontend.md Outdated Show resolved Hide resolved
build/extend/dockerfile-frontend.md Outdated Show resolved Hide resolved
build/extend/dockerfile-frontend.md Outdated Show resolved Hide resolved
build/extend/index.md Outdated Show resolved Hide resolved
build/extend/index.md Outdated Show resolved Hide resolved
build/extend/index.md Outdated Show resolved Hide resolved
build/extend/index.md Outdated Show resolved Hide resolved
build/extend/index.md Outdated
Comment on lines 58 to 61
A frontend is a component that takes a human-readable
build format and converts it to LLB so BuildKit can execute it. Frontends can
be distributed as images, and the user can target a specific version of a
frontend that is guaranteed to work for the features used by their definition.
Copy link
Contributor

Choose a reason for hiding this comment

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

for later: I think we will want to lift the description of "what's a BuildKit frontend" to a more prominent/visible place. I was confused about why it was called frontends until I read these paragraphs, and now it totally makes sense. Let's leave it here for now though!

jedevc
jedevc reviewed Oct 24, 2022
View reviewed changes
build/extend/dockerfile-frontend.md Outdated Show resolved Hide resolved
build/extend/dockerfile-frontend.md Outdated Show resolved Hide resolved
@crazy-max crazy-max changed the title build: extending buildkit section build: buildkit section Oct 24, 2022
crazy-max
crazy-max commented Oct 24, 2022
View reviewed changes
Dockerfile Outdated Show resolved Hide resolved
@crazy-max crazy-max mentioned this pull request Oct 25, 2022
Merged
@crazy-max crazy-max force-pushed the buildx-extend branch 2 times, most recently from 88d096c to 9834c19 Compare October 25, 2022 08:47
jedevc
jedevc previously approved these changes Oct 25, 2022
View reviewed changes
Copy link
Contributor

@jedevc jedevc left a comment

Choose a reason for hiding this comment

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

LGTM once the corresponding buildkit PR is merged.

@crazy-max
Copy link
Member Author

crazy-max commented Oct 25, 2022 •
edited 

Ran on 1842 files!


- ./_site/engine/reference/commandline/build/index.html
  *  linking to internal hash #buildkit that does not exist (line 849)
     <a href="/engine/reference/builder/#buildkit">BuildKit backend</a>
  *  linking to internal hash #buildkit that does not exist (line 1114)
     <a href="/engine/reference/builder/#buildkit">enable BuildKit</a>
  *  linking to internal hash #buildkit that does not exist (line 1156)
     <a href="/engine/reference/builder/#buildkit">enable BuildKit</a>

Oh more links need to be changed on docker/cli repo.

Edit:

PRs opened:

This was referenced Oct 25, 2022
Merged
Closed
Merged
Merged
dvdksn
dvdksn reviewed Oct 25, 2022
View reviewed changes
Copy link
Contributor

@dvdksn dvdksn left a comment

Choose a reason for hiding this comment

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

LGTM; bunch of nits

build/building/packaging.md Outdated Show resolved Hide resolved
build/building/packaging.md Outdated Show resolved Hide resolved
language/python/build-images.md Outdated Show resolved Hide resolved
language/nodejs/build-images.md Outdated Show resolved Hide resolved
language/java/build-images.md Outdated Show resolved Hide resolved
language/golang/build-images.md Outdated Show resolved Hide resolved
@crazy-max
Copy link
Member Author

Thanks for the review @dvdksn and @jedevc. Will wait for docker/cli#3832 to be merged to fix the htmlproofer issue.

@crazy-max crazy-max force-pushed the buildx-extend branch 2 times, most recently from 52f37b6 to 3d470b0 Compare October 25, 2022 17:40
@crazy-max
build: buildkit section
71a537d 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
build: merge build enhancements page in build section
271f8c3 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
build: update cross-linking in multi-stage page
04b22d7 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
build: merge dockerfile creation page in build section
2bac3f3 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
engine: update reference docs with latest changes from 20.10 branch
2da2d5e 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max crazy-max merged commit 3252d56 into docker:main Oct 25, 2022
@crazy-max crazy-max deleted the buildx-extend branch October 25, 2022 18:03
@crazy-max crazy-max mentioned this pull request Nov 4, 2022
Closed
@crazy-max crazy-max added the area/build Relates to Dockerfiles or docker build command label Nov 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dvdksn dvdksn dvdksn approved these changes

@jedevc jedevc jedevc left review comments

@usha-mandya usha-mandya Awaiting requested review from usha-mandya

@jerae-duffin jerae-duffin Awaiting requested review from jerae-duffin

@craig-osterhout craig-osterhout Awaiting requested review from craig-osterhout

@aevesdocker aevesdocker Awaiting requested review from aevesdocker

Assignees
No one assigned
Labels
area/build Relates to Dockerfiles or docker build command
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@crazy-max @jedevc @dvdksn