Skip to content

dockerfile: new reference location - #14948

Merged
thaJeztah merged 2 commits into
docker:masterfrom
crazy-max:dockerfile-ref-newloc
Jul 8, 2022
Merged

dockerfile: new reference location#14948
thaJeztah merged 2 commits into
docker:masterfrom
crazy-max:dockerfile-ref-newloc

Conversation

@crazy-max

@crazy-maxcrazy-max commented Jun 15, 2022

Copy link
Copy Markdown
Member

needs moby/buildkit#2902

Dockerfile reference is now located in the BuildKit repository.

Preview: https://deploy-preview-14948--docsdocker.netlify.app/engine/reference/builder/

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

@netlify

netlifyBot commented Jun 15, 2022

Copy link
Copy Markdown

Deploy Preview for docsdocker ready!

Built without sensitive environment variables

NameLink
🔨 Latest commitf299b0b
🔍 Latest deploy loghttps://app.netlify.com/sites/docsdocker/deploys/62bc5ce158f17500081c7985
😎 Deploy Previewhttps://deploy-preview-14948--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.

Comment thread_config.yml Outdated
Comment thread_config.yml Outdated
@crazy-max
crazy-maxforce-pushed the dockerfile-ref-newloc branch from 1e5c48a to 267d3c0CompareJune 15, 2022 16:04
Comment threadtest.md Outdated

- A link to an auto-generated reference page that we pull in during docs builds:
[/engine/reference/builder/#env](/engine/reference/builder/#env).
[/dockerfile/reference/#env](/dockerfile/reference/#env).

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 we should start to consider using /reference/xxxx again for URLs instead;

  • /reference/dockerfile/
  • /reference/commandline/xxx etc

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Hum indeed good point

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Keeping in /engine/reference/builder/ for now. Let's do the slug change in a follow-up.

@crazy-max
crazy-maxforce-pushed the dockerfile-ref-newloc branch from 267d3c0 to a67f515CompareJune 22, 2022 15:35
@crazy-max
crazy-max marked this pull request as ready for review June 22, 2022 15:40
@crazy-max
crazy-max marked this pull request as draft June 22, 2022 15:40
@crazy-max
crazy-maxforce-pushed the dockerfile-ref-newloc branch from a67f515 to 4dec9e3CompareJune 24, 2022 19:46
@crazy-max
crazy-max marked this pull request as ready for review June 24, 2022 19:48
@crazy-max
crazy-max requested a review from thaJeztahJune 24, 2022 19:48
@crazy-max

Copy link
Copy Markdown
MemberAuthor

@thaJeztah As discussed on Slack, we don't fetch from a release branch but master branch of the BuildKit repository for reference docs. Will open a follow-up PR on BuildKit to mark new features as suggested.

I have started to work on the Dockerfile reference changelog that will be on this repo in a dedicated page so we can cross-link with sections in reference docs but we need to first update the slug as the Dockerfile reference is not a section atm: /engine/reference/builder. Like you said we could switch to /reference/dockerfile/ to access reference docs and in the same spirit have /reference/dockerfile/release-notes for dockerfile changelog. WDYT @thaJeztah?

@crazy-max
crazy-maxforce-pushed the dockerfile-ref-newloc branch from 4dec9e3 to aa0dd60CompareJune 28, 2022 10:54
@crazy-max

Copy link
Copy Markdown
MemberAuthor

Simplified this PR now that #14799 is merged. No need extra plugin to move pages around as the correct reference is picked up by fetch remote plugin to create edit and issue link: https://deploy-preview-14948--docsdocker.netlify.app/engine/reference/builder/

@crazy-max
crazy-maxforce-pushed the dockerfile-ref-newloc branch from aa0dd60 to 136854aCompareJune 29, 2022 14:05
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
crazy-maxforce-pushed the dockerfile-ref-newloc branch from 136854a to f299b0bCompareJune 29, 2022 14:08
@usha-mandyausha-mandya added the area/ux Issue affects functionality of docs.docker.com label Jun 29, 2022
@usha-mandya

Copy link
Copy Markdown
Member

@thaJeztah are we good to merge this PR? Thanks

@thaJeztahthaJeztah left a comment

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.

LGTM

@thaJeztah
thaJeztah merged commit 77f88c7 into docker:masterJul 8, 2022
@crazy-max
crazy-max deleted the dockerfile-ref-newloc branch July 8, 2022 10:37
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/uxIssue affects functionality of docs.docker.com

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@crazy-max@usha-mandya@thaJeztah