Skip to content

Conversation

@crazy-max
Copy link
Member

@crazy-max crazy-max commented Jul 13, 2022

needs #15151 (for proper redirects)

adds a release notes page for the dockerfile reference. needs to create a subsection for release notes and therefore also needs to change the reference location from /engine/reference/builder to /reference/dockerfile/ as discussed in #14948 (comment).

preview: https://deploy-preview-15110--docsdocker.netlify.app/reference/dockerfile/

image

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max crazy-max added the area/build Relates to Dockerfiles or docker build command label Jul 13, 2022
@netlify
Copy link

netlify bot commented Jul 13, 2022

Deploy Preview for docsdocker ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 1693315
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/62d6eda52977d500091aacba
😎 Deploy Preview https://deploy-preview-15110--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
Copy link
Member Author

htmlproofer not happy because we need to also update reference location on foreign repos (docker/cli, docker/buildx and distribution/distribution)

#16 [htmlproofer 1/1] RUN --mount=type=bind,from=generate,source=/out,target=_site   htmlproofer ./_site     --disable-external     --internal-domains="docs.docker.com,docs-stage.docker.com,localhost:4000"     --file-ignore="/^./_site/engine/api/.*$/,./_site/registry/configuration/index.html"     --url-ignore="/^/docker-hub/api/latest/.*$/,/^/engine/api/v.+/#.*$/,/^/glossary/.*$/"
#16 0.563 Running ["LinkCheck", "ImageCheck", "ScriptCheck"] on ["./_site"] on *.html... 
#16 0.563 
#16 0.563 
#16 173.0 Ran on 1717 files!
#16 173.0 
#16 173.0 
#16 173.0 - ./_site/engine/extend/config/index.html
#16 173.0   *  linking to internal hash #entrypoint that does not exist (line 205)
#16 173.0      <a href="../reference/builder.md#entrypoint"></a>
#16 173.0   *  linking to internal hash #workdir that does not exist (line 210)
#16 173.0      <a href="../reference/builder.md#workdir"></a>
#16 173.0 - ./_site/engine/reference/commandline/build/index.html
#16 173.0   *  linking to internal hash #add that does not exist (line 759)
#16 173.0      <a href="/engine/reference/builder/#add"><em>ADD</em></a>
#16 173.0   *  linking to internal hash #buildkit that does not exist (line 1151)
#16 173.0      <a href="/engine/reference/builder/#buildkit">enable BuildKit</a>
#16 173.0   *  linking to internal hash #buildkit that does not exist (line 844)
#16 173.0      <a href="/engine/reference/builder/#buildkit">BuildKit backend</a>
#16 173.0   *  linking to internal hash #buildkit that does not exist (line 1109)
#16 173.0      <a href="/engine/reference/builder/#buildkit">enable BuildKit</a>
#16 173.0   *  linking to internal hash #copy that does not exist (line 136)
#16 173.0      <a href="/engine/reference/builder/#copy"><em>COPY</em></a>
#16 173.0   *  linking to internal hash #copy that does not exist (line 1071)
#16 173.0      <a href="/engine/reference/builder/#copy"></a>
#16 173.0   *  linking to internal hash #dockerignore-file that does not exist (line 276)
#16 173.0      <a href="/engine/reference/builder/#dockerignore-file">.dockerignore file</a>
#16 173.0   *  linking to internal hash #dockerignore-file that does not exist (line 842)
#16 173.0      <a href="/engine/reference/builder/#dockerignore-file">creating a .dockerignore file</a>
#16 173.0 - ./_site/engine/reference/commandline/buildx_build/index.html
#16 173.0   *  linking to internal hash #automatic-platform-args-in-the-global-scope that does not exist (line 963)
#16 173.0      <a href="/engine/reference/builder/#automatic-platform-args-in-the-global-scope">
#16 173.0 documentation</a>
#16 173.0 - ./_site/engine/reference/commandline/cli/index.html
#16 173.0   *  linking to internal hash #buildkit that does not exist (line 219)
#16 173.0      <a href="../builder.md#buildkit">BuildKit backend</a>
#16 173.0 - ./_site/engine/reference/run/index.html
#16 173.0   *  internally linking to builder.md, which does not exist (line 1808)
#16 173.0      <a href="builder.md"><em>Dockerfile</em></a>
#16 173.0 - ./_site/language/nodejs/build-images/index.html
#16 173.0   *  linking to internal hash #parser-directives that does not exist (line 258)
#16 173.0      <a href="/reference/dockerfile/index.md#parser-directives">Parser directives</a>
#16 173.0   *  linking to internal hash #syntax that does not exist (line 255)
#16 173.0      <a href="/reference/dockerfile/index.md#syntax"> parser directive</a>
#16 173.0 - ./_site/registry/spec/deprecated-schema-v1/index.html
#16 173.0   *  linking to internal hash #from that does not exist (line 141)
#16 173.0      <a href="https://docs.docker.com/engine/reference/builder/#from">Dockerfile reference</a>
#16 173.0 
#16 173.0 HTML-Proofer found 16 failures!
#16 ERROR: process "/bin/sh -c htmlproofer ./_site     --disable-external     --internal-domains=\"docs.docker.com,docs-stage.docker.com,localhost:4000\"     --file-ignore=\"/^./_site/engine/api/.*$/,./_site/registry/configuration/index.html\"     --url-ignore=\"/^/docker-hub/api/latest/.*$/,/^/engine/api/v.+/#.*$/,/^/glossary/.*$/\"" did not complete successfully: exit code: 1

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@docker-robott
Copy link
Collaborator

Thanks for the pull request. We'd like to make our product docs better, but haven’t been able to review all the suggestions.
As our docs have also diverged, we do not have the bandwidth to review and rebase old pull requests.

If the updates are still relevant, review our contribution guidelines and rebase your pull request against the latest version of the docs, then mark it as fresh with a /remove-lifecycle stale comment.
If not, this pull request will be closed in 30 days. This helps our maintainers focus on the active pull requests.

Prevent pull requests from auto-closing with a /lifecycle frozen comment.

/lifecycle stale

ref: "master"
paths:
- dest: "engine/reference/builder.md"
- dest: "reference/dockerfile"
Copy link
Member

Choose a reason for hiding this comment

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

Did these need the trailing slash? (to prevent extra redirects?)

Suggested change
- dest: "reference/dockerfile"
- dest: "reference/dockerfile/"

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes indeed, I just reopened this PR to remember it exists tbh 😅 but would love to have it merged. I think we still need to figure out how and when we want to move /engine/reference to /reference first.

@crazy-max
Copy link
Member Author

/lifecycle frozen

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/build Relates to Dockerfiles or docker build command lifecycle/frozen lifecycle/stale

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants