docs icon indicating copy to clipboard operation
docs copied to clipboard

site: improve schema.org json-ld markup

Open dvdksn opened this issue 2 weeks ago • 1 comments

Improves the schema.org json-ld markup to include more metadata.

For example, for this page: https://deploy-preview-23812--docsdocker.netlify.app/build/building/multi-stage/

Our current json-ld metadata is a bit broken:

{
  "@context":"https://schema.org",
  "@type":"WebPage",
  "headline":"\"Multi-stage\"",
  "description":"\"Learn about multi-stage builds and how you can use them to improve your builds and get smaller images \"",
  "url":"https:\/\/docs.docker.com\/build\/building\/multi-stage\/"
}

With this patch, we get more, well-formatted metadata:

  {
      "@context": "https://schema.org",
      "@type": "TechArticle",
      "articleSection": "manuals",
      "author": {
          "@type": "Organization",
          "name": "Docker Inc",
          "url": "https://www.docker.com"
      },
      "dateModified": "2024-09-10T15:26:47+02:00",
      "description": "Learn about multi-stage builds and how you can use them to improve your builds and get smaller images ",
      "headline": "Multi-stage",
      "keywords": "build, best, practices",
      "publisher": {
          "@type": "Organization",
          "logo": {
              "@type": "ImageObject",
              "url": "https://docs.docker.com/assets/images/docker-logo.png"
          },
          "name": "Docker Inc",
          "url": "https://www.docker.com"
      },
      "url": "https://docs.docker.com/build/building/multi-stage/"
  }

And we also get the BreadCrumbList (page hierarchy):

  {
      "@context": "https://schema.org",
      "@type": "BreadcrumbList",
      "itemListElement": [
          {
              "@type": "ListItem",
              "item": {
                  "@id": "https://docs.docker.com/manuals/",
                  "name": "Manuals"
              },
              "position": 1
          },
          {
              "@type": "ListItem",
              "item": {
                  "@id": "https://docs.docker.com/build/",
                  "name": "Docker Build"
              },
              "position": 2
          },
          {
              "@type": "ListItem",
              "item": {
                  "@id": "https://docs.docker.com/build/building/multi-platform/",
                  "name": "Multi-platform"
              },
              "position": 3
          }
      ]
  }

dvdksn avatar Dec 04 '25 16:12 dvdksn

Deploy Preview for docsdocker ready!

Name Link
Latest commit 1e722fdad57be880a9fdb6b4348dad1846c71635
Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6932d4341f1ff60008c6302d
Deploy Preview https://deploy-preview-23812--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.

netlify[bot] avatar Dec 04 '25 16:12 netlify[bot]