Skip to content

Conversation

@dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Aug 8, 2024

@netlify /learning-paths/

Description

This PR adds another top-level section to the site: Learning paths

Learning paths are articles that guide users through a series of articles, videos, and other resources to help them learn a Docker product, feature, or concept.

The learning paths are linked in the site's top navigation bar, and have a dedicated page that lists all available learning paths.

Learning path pages are similar to the guide overviews, listing a number of modules that make up the learning path.
Paths have the following metadata:

title: "Learning path title"
description: "A brief description of the learning path" # meta description for SEO
summary: "A brief summary of the learning path" # excerpt and summary for the page
params:
  image: "/images/path-image.jpg" # path timage
  skill: "Beginner" # skill level
  time: "1 hour" # estimated time to complete
  prereq: "Docker installed" # prerequisites

The layout of each learning path is as follows:

  • Title
  • Summary
  • Guide stats (skill level, time, prerequisites)
  • Subject overview
  • What you'll learn
  • Tools integration
  • Who's this for?
  • Modules (list of modules in the learning path)

@netlify
Copy link

netlify bot commented Aug 8, 2024

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 7083355
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/66c6f5a638baba00080cf682
😎 Deploy Preview https://deploy-preview-20563--docsdocker.netlify.app/learning-paths/
📱 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.

@github-actions github-actions bot added the hugo Updates related to hugo label Aug 8, 2024
@dvdksn dvdksn marked this pull request as ready for review August 8, 2024 14:31
@dvdksn dvdksn requested a review from a team August 8, 2024 14:31
@sbenhoff007
Copy link
Contributor

On the Docker Compose page, the URL for Control Startup and Shutdown Order with Compose is wrong. It should be: https://docs.docker.com/compose/startup-order/

It was like that in the Google doc and I've updated it.

@sbenhoff007
Copy link
Contributor

On the Docker Scout page, remove the "Modules" heading.

@dvdksn
Copy link
Contributor Author

dvdksn commented Aug 9, 2024

On the Docker Scout page, remove the "Modules" heading.

I am thinking about keeping the heading, just for the sake of a reasonable HTML document structure. The previous heading otherwise becomes "Tools integration" which doesn't make sense semantically. So I will add it in to the build cloud page instead (where it was missing)

@dvdksn dvdksn force-pushed the learning-paths branch 4 times, most recently from bb7d52c to b195bf6 Compare August 12, 2024 14:41
aevesdocker
aevesdocker previously approved these changes Aug 13, 2024
Copy link
Contributor

@aevesdocker aevesdocker left a comment

Choose a reason for hiding this comment

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

Few nits that can be done in a follow up. Otherwise, looks great

@dvdksn dvdksn force-pushed the learning-paths branch 2 times, most recently from cddaac9 to c27a084 Compare August 19, 2024 11:37
For some inexplicable reason, the link render hook was failing, probably
caused by cases where goldmark was called recursively by shortcodes.

This change changas the render hook to use the global `pages` pointer
instead of the .Pages pointer of the render hook context. Seems to work.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
@dvdksn dvdksn requested a review from a team August 22, 2024 09:00
Copy link
Member

@usha-mandya usha-mandya left a comment

Choose a reason for hiding this comment

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

:shipit:

@dvdksn dvdksn merged commit b7f0232 into docker:main Aug 23, 2024
@dvdksn dvdksn deleted the learning-paths branch August 23, 2024 04:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

hugo Updates related to hugo status/review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants