Skip to content

Improve docs#1682

Merged
dgageot merged 3 commits intoGoogleContainerTools:masterfrom
dgageot:improve-docs-v3
Feb 21, 2019
Merged

Improve docs#1682
dgageot merged 3 commits intoGoogleContainerTools:masterfrom
dgageot:improve-docs-v3

Conversation

@dgageot
Copy link
Copy Markdown
Contributor

@dgageot dgageot commented Feb 21, 2019

  • Improve the static pages
  • Improve the Go structs to make them more friendly to the documentation generator (test section and profile patches)
  • fixed comments here and there

@codecov-io
Copy link
Copy Markdown

codecov-io commented Feb 21, 2019

Codecov Report

Merging #1682 into master will increase coverage by 0.07%.
The diff coverage is 95.45%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1682      +/-   ##
==========================================
+ Coverage   47.48%   47.56%   +0.07%     
==========================================
  Files         122      122              
  Lines        5456     5464       +8     
==========================================
+ Hits         2591     2599       +8     
  Misses       2604     2604              
  Partials      261      261
Impacted Files Coverage Δ
pkg/skaffold/schema/v1beta4/upgrade.go 58.62% <100%> (ø) ⬆️
pkg/skaffold/schema/profiles.go 93.7% <100%> (+0.36%) ⬆️
hack/schemas/main.go 87.86% <100%> (+0.07%) ⬆️
pkg/skaffold/runner/runner.go 60.2% <66.66%> (ø) ⬆️

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 7bbcc5e...d4dc9bc. Read the comment docs.

@dgageot dgageot added the docs-modifications runs the docs preview service on the given PR label Feb 21, 2019
@container-tools-bot
Copy link
Copy Markdown

Please visit http://35.236.109.79:1313 to view changes to the docs.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Feb 21, 2019
[Docker Engine APIs](https://docs.docker.com/develop/sdk/). You can, however,
ask Skaffold to use the [command-line interface](https://docs.docker.com/engine/reference/commandline/cli/)
[Docker Engine APIs](https://docs.docker.com/develop/sdk/). Skaffold can, however,
be aked to use the [command-line interface](https://docs.docker.com/engine/reference/commandline/cli/)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
be aked to use the [command-line interface](https://docs.docker.com/engine/reference/commandline/cli/)
be asked to use the [command-line interface](https://docs.docker.com/engine/reference/commandline/cli/)

Signed-off-by: David Gageot <david@gageot.net>
Signed-off-by: David Gageot <david@gageot.net>
To use the local Docker daemon, add build type `local` to the `build` section
of `skaffold.yaml`. The following options can optionally be configured:

{{< schema root="LocalBuild" >}}
Copy link
Copy Markdown
Contributor

@balopat balopat Feb 21, 2019

Choose a reason for hiding this comment

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

looking at this rendered it is a bit weird that the default is empty for push - shouldn't it be false there too?

image

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

In fact it depends on the k8s context.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

oh yeah, this is due to a previous merge - I guess it's a more complex logic as currently on skaffold.dev it is manually specified as "false for local clusters, true for remote clusters."...

@balopat balopat self-requested a review February 21, 2019 16:48
Copy link
Copy Markdown
Contributor

@balopat balopat left a comment

Choose a reason for hiding this comment

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

LGTM, caveat: 1 typo and 1 question for complex default values

@dgageot
Copy link
Copy Markdown
Contributor Author

dgageot commented Feb 21, 2019

Let me fix the typo

@dgageot
Copy link
Copy Markdown
Contributor Author

dgageot commented Feb 21, 2019

Travis is green but can't seem to get the status updated. Let's merge this PR

@dgageot dgageot merged commit a98ad52 into GoogleContainerTools:master Feb 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants