Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Create dedicated Docker Build section #14642
Changes from all commits
3e44dd8
017d64b
1ef8c8c
e87f4a3
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
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
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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:
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:
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
There was a problem hiding this comment.
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.).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.