Engdocs 2080

[aevesdocker]

Description

PR creates includes for the Compose GUI feature. No new content, just rejigging.

Related issues or tickets

Reviews

• Technical review
• Editorial review
• Product review

[netlify]

✅ Deploy Preview for docsdocker ready!

Name	Link
🔨 Latest commit	9a5d78d
🔍 Latest deploy log	https://app.netlify.com/sites/docsdocker/deploys/664772c404e6e4000868e580
😎 Deploy Preview	https://deploy-preview-19953--docsdocker.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[aevesdocker]

code formatting and links don't format correctly in includes. Will address this in a follow up PR

[dvdksn]

How is Docker Desktop pulling these descriptions? If it's happening runtime, I think we need an intermediate layer, such as a JSON API like we have for the search index, which decouples the source files and the distribution of headless fragments.

[dvdksn]

How is Docker Desktop pulling these descriptions? If it's happening runtime, I think we need an intermediate layer, such as a JSON API like we have for the search index, which decouples the source files and the distribution of headless fragments.

I discussed this with @jhrotko and I think we need to provide a more reliable endpoint that Docker Desktop can use to fetch these strings. For the same reason that we use /go/ links, to avoid unintentionally breaking an application. Fetching these strings from the markdown files is too brittle.

I can do the implementation. I think we should serve these as a JSON file. We may need to serve other applications in a similar way in the future, so if we want to be future-proof we should make this a generic implementation. The most straightforward and generic approach is to just assign each string a unique identifier:

{
  "composeBuild": "Build is an optional part of the Compose Specification. It tells Compose how to (re)build an application from source and lets you define the build process within a Compose file in a portable way.",
  "composeVolumes": "Volumes are persistent data stores implemented by the container engine. Compose offers a neutral way for services to mount volumes, and configuration parameters to allocate them to infrastructure. The top-level `volumes` declaration lets you configure named volumes that can be reused across multiple services."
}

We should probably stick a /go/ redirect in front of this too.

[aevesdocker]

@dvdksn sounds good. I just pushed Joana's review comments and added some more files, so I guess now over to you? Is it easier to get this merged first?

[dvdksn]

Feel free to merge @aevesdocker and I can open a follow-up

[jhrotko]

LGTM