Skip to content

Enhanced driver guides - #1233

Merged
tonistiigi merged 3 commits into
docker:masterfrom
jedevc:drivers-guides
Jul 29, 2022
Merged

Enhanced driver guides#1233
tonistiigi merged 3 commits into
docker:masterfrom
jedevc:drivers-guides

Conversation

@jedevc

Copy link
Copy Markdown
Collaborator

This PR adds a new basic docker-container guide to match with the existing remote and kubernetes guides. Because this is a smaller and simpler driver, the guide is as well 🎉

Additionally, to improve organization, all the driver guides are moved to a dedicated folder, with an index file to describe the high of all the drivers, pulling out existing content from the README, and introducing a new feature comparison table (not sure if I'm missing any essential features?).

Also, I've added a little bit of further reading at the end of each guide to point back to the driver opts in the buildx build reference.

@jedevc
jedevc requested a review from crazy-maxJuly 25, 2022 12:46
Comment threaddocs/guides/drivers/docker-container.md Outdated
Comment threaddocs/guides/drivers/index.md Outdated
Comment threaddocs/guides/drivers/index.md Outdated

@crazy-maxcrazy-max left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, PTAL @tonistiigi

@tonistiigitonistiigi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This can be follow-up but if we have guides for specific drivers I think they should cover the specific driver-opt that they take or at least link to the correct place.

Comment threaddocs/guides/drivers/docker-container.md Outdated
Comment threadREADME.md Outdated
@jedevc

Copy link
Copy Markdown
CollaboratorAuthor

This can be follow-up but if we have guides for specific drivers I think they should cover the specific driver-opt that they take or at least link to the correct place.

From @crazy-max earlier:

Better use absolute url for docs reference so it doesn't break links on GitHub but I'm ok to use links to markdown files for relative file in guides folder.

Once we do a release, and all of our docs guides+references can be taken from the release branch, we can link properly :)

jedevc added 3 commits July 28, 2022 11:21
Create a dedicated folder for information on drivers, and write a new
index.md with content adapted from the README, and a new feature
comparisons table.
Signed-off-by: Justin Chadwell <me@jedevc.com>
Signed-off-by: Justin Chadwell <me@jedevc.com>
Signed-off-by: Justin Chadwell <me@jedevc.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@jedevc@tonistiigi@crazy-max