Skip to content
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.

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

Create dedicated Docker Build section #14642

Closed
wants to merge 4 commits into from

Conversation

crazy-max
Copy link
Member

@crazy-max crazy-max commented May 2, 2022

As discussed with @usha-mandya and @thaJeztah, create a dedicated "Docker Build" section in "Manuals". This is a first step to put documentation related to build together.

I moved the install part in a dedicated page, I think it makes sense (specially for the /go redirect to install buildx).

In some follow-ups I will take a look at the "Guides" and move some build bits to "Manuals" or at least mutualize some of them.

I will also check how we can fetch buildx guides and add them to our docs: https://github.com/docker/buildx/tree/master/docs/guides as well as the Dockerfile syntax from BuildKit repo: https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/syntax.md

When this one is merged I will also look how we can prepare our documentation for the next Docker Engine 22 relative to docker/cli#3314

Signed-off-by: CrazyMax [email protected]

@netlify
Copy link

netlify bot commented May 2, 2022

Deploy Preview for docsdocker ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e87f4a3
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6298543de2d5d90007475ed3
😎 Deploy Preview https://deploy-preview-14642--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 settings.

@crazy-max
Copy link
Member Author

I made small changes. The new TOC looks fine to me in the "Manuals" tab to begin with: https://deploy-preview-14642--docsdocker.netlify.app/build/buildx/

image

It's just a move from "Docker Engine > Docker Buildx" to "Docker Build > Buildx component" atm.

@dockertopia I think you can iterate in a follow-up in the "Guides" tab for newcomers and make some cross references to the "Manuals" tab but would need an overview in "Docker Build" section first as we discussed at the last meeting with @usha-mandya and @thaJeztah.

I also added the build team and @dockertopia to the CODEOWNERS for the build folder.

Let me know what you think about it.

@crazy-max
Copy link
Member Author

image

Ah looks like it needs to be a member of this repo. Maybe it will be too noisy. Will just add me in the meantime.

description: Working with Docker Buildx
keywords: Docker, buildx, multi-arch
Copy link
Contributor

Choose a reason for hiding this comment

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

How does this metadata work? Does this help search or help create related topics? Just wondering how "multi-arch" would work depending on how this metadata is picked-up.

Copy link
Member Author

Choose a reason for hiding this comment

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

Keywords are like tags that will be used to enhance search results and are added at the bottom of the page:

image

image

They are also added as meta tag for SEO https://github.com/docker/docker.github.io/blob/9294453e5fe816824ba855e92eae3fc5b16c9c11/_includes/head.html#L39 but I don't think this is relevant anymore as it's not used by search engines anymore like Google:

[…] keyword meta tags quickly became an area where someone could stuff often-irrelevant keywords without typical visitors ever seeing those keywords. Because the keywords meta tag was so often abused, many years ago Google began disregarding the keywords meta tag.

Bing went one step further in 2011 when they announced they use the tag as a spam signal.

I think we should remove the meta keywords in the future but would need to put in place a client-side search implementation, omitting the need for the integration of third-party services (Google in our case), which might not be compliant with privacy regulations. Moreover, search even works offline, allowing users to download our documentation. I think lunr could be a good candidate for this. See for example my POC with MkDocs using a client-side search: https://crazymax.dev/docker-docs/

cc @usha-mandya @thaJeztah

Copy link
Contributor

Choose a reason for hiding this comment

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

It would be great to be able to optimize the search indexes ourselves. It could take the docs experience to another level, when you'd search a term you'd already get the best matches from the team's perspective what are the best overall content candidates across types.
This means we could, if somebody searched "docker build" make sure the number 1 hit on the list is the Docker Build docs index as well as curate results across categories (refs, guides, blog, etc.).

Copy link
Contributor

@dockertopia dockertopia left a comment

Choose a reason for hiding this comment

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

As a general comment I would like to take a few of days to review these new pages and discuss offline the next stages re guides and expansion of this doc set.
But if you'd rather have a more simple review now to just get this new section into master and then improve on it with additional PRs, PLMK.

@crazy-max crazy-max force-pushed the build-section branch 2 times, most recently from 5ffb447 to cd05843 Compare May 20, 2022 12:13
@crazy-max
Copy link
Member Author

crazy-max commented May 23, 2022

As a general comment I would like to take a few of days to review these new pages and discuss offline the next stages re guides and expansion of this doc set. But if you'd rather have a more simple review now to just get this new section into master and then improve on it with additional PRs, PLMK.

I will add a simple Overview page for the build section first in "Manuals > Docker Build" and after that I think we can merge and iterate over it. I keep you in touch. Let me know if that sounds good to you.

@crazy-max crazy-max force-pushed the build-section branch 2 times, most recently from c1d694f to 6decea4 Compare June 2, 2022 04:22
@@ -1,7 +1,9 @@
---
title: Docker Buildx
title: Buildx component
Copy link
Contributor

@dockertopia dockertopia Jun 2, 2022

Choose a reason for hiding this comment

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

Buildx is in other places referred to as the Docker CLI Buildx plugin, I think we should be consistent.


As for structure of the Build section (and page titles) here's a working proposal

It seems this will be a broad section, WDYT about structuring the content like:
Docker Build

  1. (Build) Overview
    2 About Buildx
    2.1. Installing Buildx
    2.2. About Buildx (so not to have another overview)
    2.3. Using Buildx
    2.4. Using Bake


## Docker Desktop

Docker Buildx is included in [Docker Desktop](../../desktop/index.md) for Windows, macOS, and Linux.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Docker Buildx is included in [Docker Desktop](../../desktop/index.md) for Windows, macOS, and Linux.
Docker Buildx is a Docker CLI plugin and is shipped with [Docker Desktop](../../desktop/index.md). Docker Desktop is available for Windows, macOS, and Linux.

@crazy-max crazy-max marked this pull request as draft June 3, 2022 11:52
Copy link
Contributor

@dockertopia dockertopia left a comment

Choose a reason for hiding this comment

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

I have agreed with Kevin to review the section in general (and install and index files for build and buildx in particular) in a new build-docs branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants