Skip to content

guides: update python & add files component#25206

Open
craig-osterhout wants to merge 5 commits into
docker:mainfrom
craig-osterhout:dhi-all-the-things-1
Open

guides: update python & add files component#25206
craig-osterhout wants to merge 5 commits into
docker:mainfrom
craig-osterhout:dhi-all-the-things-1

Conversation

@craig-osterhout
Copy link
Copy Markdown
Contributor

@craig-osterhout craig-osterhout commented May 29, 2026

Description

Updated Python guide

  • Removed DOI in favor of DHI only. DHI Community is now free, so there's no reason to keep the DOI fallback path.
  • Removed the git clone sample-app pattern. Maintaining external sample repos is a burden, and split source of truth between the docs and the sample.
  • New file browser / scaffolding component. Lets users copy individual files or scaffold the whole project with one command. Replaces the role the cloned sample repo used to play.
  • New "Secure your supply chain" topic highlighting what DHI gives you and how to attach matching attestations to your own image in CI.
  • A bunch of smaller improvements: clearer intros for each topic, progressively updating the same app in all topics, ran and fixed issues, etc.

https://deploy-preview-25206--docsdocker.netlify.app/guides/python/

Related issues or tickets

ENGDOCS-3308

Reviews

  • Technical review
  • Editorial review

@netlify
Copy link
Copy Markdown

netlify Bot commented May 29, 2026

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 9d35e4f
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6a204492db021a0008c60f81
😎 Deploy Preview https://deploy-preview-25206--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 project configuration.

@github-actions github-actions Bot added hugo Updates related to hugo area/tests area/guides labels May 29, 2026
@craig-osterhout craig-osterhout changed the title guides: update python guides: update python & add files component May 29, 2026
Copy link
Copy Markdown

@docker-agent docker-agent left a comment

Choose a reason for hiding this comment

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

Assessment: 🟡 NEEDS ATTENTION

Comment thread content/guides/python/develop.md
Comment thread content/guides/python/develop.md Outdated
Copy link
Copy Markdown
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.

Reviewed the full guide — looks good, solid improvement. The inline sample + files component read well, naming and ports are consistent, and the multi-stage DHI Dockerfile is sound. Two notes on the scaffold path in the files shortcode, inline below: the heredoc delimiter one is worth fixing; the BOM one is a non-blocking follow-up.

Comment thread layouts/_shortcodes/files.html Outdated
Comment thread layouts/_shortcodes/files.html Outdated
@craig-osterhout craig-osterhout requested a review from dvdksn May 29, 2026 21:37
Copy link
Copy Markdown

@docker-agent docker-agent left a comment

Choose a reason for hiding this comment

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

Assessment: 🟡 NEEDS ATTENTION

This PR is a substantial, high-quality rework of the Python guide. The new file browser/scaffold component is well-implemented, the DHI-only approach is a good simplification, and the new supply chain topic is a valuable addition. Four issues found in the changed content.

Comment thread content/guides/python/configure-github-actions.md Outdated
Comment thread content/guides/python/lint-format-typing.md Outdated
Comment thread content/guides/python/secure-supply-chain.md Outdated
Comment thread content/guides/python/deploy.md Outdated
@craig-osterhout craig-osterhout requested a review from a team June 2, 2026 16:45
@craig-osterhout craig-osterhout added the status/review Pull requests that are ready for review label Jun 2, 2026
Copy link
Copy Markdown

@docker-agent docker-agent left a comment

Choose a reason for hiding this comment

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

Assessment: 🔴 CRITICAL

This PR rewrites the Python guides series to use Docker Hardened Images (DHI) and introduces a new {{< files >}}/{{< file >}} shortcode pair. The overall direction is solid, but there are three high-severity factual errors in the newly added content that should be fixed before merging.

High severity (3): fabricated version number, placeholder SHA-256 digest, and a typo in the develop.md overview.
Medium severity (2): an absolute claim that pre-commit hooks bypass prevention is inaccurate, and the example database password lacks a production-use warning.

Comment thread content/guides/python/develop.md
Comment thread content/guides/python/lint-format-typing.md
Comment thread content/guides/python/secure-supply-chain.md
Comment thread content/guides/python/develop.md
Comment thread content/guides/python/lint-format-typing.md Outdated
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Copy link
Copy Markdown
Contributor

@akristen akristen left a comment

Choose a reason for hiding this comment

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

Aside from the vale nit, LGTM

@akristen
Copy link
Copy Markdown
Contributor

akristen commented Jun 4, 2026

also the new component is pretty snazzy

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

Labels

area/guides area/tests hugo Updates related to hugo status/review Pull requests that are ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants