Skip to content

fix: update include.html for heading error #21906

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
Merged
merged 1 commit into from
Jan 29, 2025
Merged

fix: update include.html for heading error #21906

merged 1 commit into from
Jan 29, 2025

Conversation

@sarahsanders-docker
Copy link
Contributor

@sarahsanders-docker sarahsanders-docker commented Jan 27, 2025 •
edited by atlassian bot
Loading

Description

  • Problem: Some include shortcodes produce missing H3 ToC headings (ex: https://docker.slack.com/archives/C039ZM6GH4Z/p1737545677728649)
  • Fix: Update to include.html uses Hugo readFile function to fix parsing errors and updated all include shortcodes using Find and Replace to use correct syntax: {{% "include-file" %}}

Related issues or tickets

Reviews

  • Technical review

@github-actions github-actions bot added area/engine Issue affects Docker engine/daemon area/compose Relates to docker-compose.yml spec or docker-compose binary area/install Relates to installing a product area/hub Issue affects Docker Hub area/build Relates to Dockerfiles or docker build command area/swarm Issue affects swarm and clustering functionality of docker area/desktop Issue affects a desktop edition of Docker. E.g docker for mac area/cli Relates to the CLI client area/security area/subscription Relates to Docker pricing and subscription area/extensions Relates to Docker Extensions area/admin Relates to Docker Admin area/scout Relates to Docker Scout hugo Updates related to hugo area/billing area/guides labels Jan 27, 2025
@netlify
Copy link

netlify bot commented Jan 27, 2025 •
edited
Loading

✅ Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 5ab75df
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6797f7604b08af0008e8c5b4
😎 Deploy Preview https://deploy-preview-21906--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 configuration.

craig-osterhout
craig-osterhout approved these changes Jan 28, 2025
View reviewed changes
Copy link
Contributor

@craig-osterhout craig-osterhout left a comment

Choose a reason for hiding this comment

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

Checked https://deploy-preview-21906--docsdocker.netlify.app/engine/install/ubuntu/#install-using-the-convenience-script and it LGTM

@sarahsanders-docker sarahsanders-docker merged commit d083617 into docker:main Jan 29, 2025
14 checks passed
@sarahsanders-docker sarahsanders-docker deleted the toc-includes-updates branch March 12, 2025 12:44
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

@craig-osterhout craig-osterhout craig-osterhout approved these changes

@aevesdocker aevesdocker Awaiting requested review from aevesdocker aevesdocker is a code owner

@crazy-max crazy-max Awaiting requested review from crazy-max

Assignees

No one assigned

Labels

area/admin Relates to Docker Admin area/billing area/build Relates to Dockerfiles or docker build command area/cli Relates to the CLI client area/compose Relates to docker-compose.yml spec or docker-compose binary area/desktop Issue affects a desktop edition of Docker. E.g docker for mac area/engine Issue affects Docker engine/daemon area/extensions Relates to Docker Extensions area/guides area/hub Issue affects Docker Hub area/install Relates to installing a product area/scout Relates to Docker Scout area/security area/subscription Relates to Docker pricing and subscription area/swarm Issue affects swarm and clustering functionality of docker hugo Updates related to hugo status/review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sarahsanders-docker @dvdksn @craig-osterhout