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

Enhance documentation #299

Merged
merged 1 commit into from Feb 17, 2021
Merged

Enhance documentation #299

merged 1 commit into from Feb 17, 2021

Conversation

crazy-max
Copy link
Member

Fixes #215

And also:

  • Split documentation to a docs directory
  • Add note about issue with local cache backend (keeps growing)
  • Update GitHub cache workflow with temp fix
  • Note about future GitHub cache backend
  • Workflow example to use secrets

cc @tonistiigi @MarcelCoding @ahmadnassri

Signed-off-by: CrazyMax crazy-max@users.noreply.github.com

@ahmadnassri
Copy link

looks good, and a good description for the topic in #215

@tonistiigi
Copy link
Member

tonistiigi commented Feb 17, 2021

After the first example can we had a section explaining setup-buildx and setup-qemu are optional and when they are needed. And maybe a link to a longer writeup in the advanced section explaining usage of driver and the main differences(multi-platform, load, cache-export).

@crazy-max
Copy link
Member Author

@tonistiigi Thanks for your feedback. I will make some changes based on this.

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@codecov-io
Copy link

Codecov Report

Merging #299 (a63b18d) into master (af867d4) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #299   +/-   ##
=======================================
  Coverage   74.39%   74.39%           
=======================================
  Files           4        4           
  Lines         164      164           
  Branches       28       28           
=======================================
  Hits          122      122           
  Misses         22       22           
  Partials       20       20           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update af867d4...a63b18d. Read the comment docs.

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.

Docs: needs more clarifications on default behaviour
4 participants