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

Improve docs #1682

Merged
merged 3 commits into from Feb 21, 2019
Merged

Improve docs #1682

merged 3 commits into from Feb 21, 2019

Conversation

@dgageot
Copy link
Member

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
@googlebot googlebot added the cla: yes label Feb 21, 2019
@dgageot dgageot force-pushed the dgageot:improve-docs-v3 branch from e42b359 to d4dc9bc Feb 21, 2019
@codecov-io

This comment has been minimized.

Copy link

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.

@container-tools-bot

This comment has been minimized.

Copy link

container-tools-bot commented Feb 21, 2019

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

[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/)

This comment has been minimized.

Copy link
@balopat

balopat Feb 21, 2019

Collaborator
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/)
dgageot added 3 commits Feb 21, 2019
Signed-off-by: David Gageot <david@gageot.net>
Signed-off-by: David Gageot <david@gageot.net>
### Configuration

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" >}}

This comment has been minimized.

Copy link
@balopat

balopat Feb 21, 2019

Collaborator

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

image

This comment has been minimized.

Copy link
@dgageot

dgageot Feb 21, 2019

Author Member

In fact it depends on the k8s context.

This comment has been minimized.

Copy link
@balopat

balopat Feb 21, 2019

Collaborator

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 Feb 21, 2019
Copy link
Collaborator

balopat left a comment

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

@dgageot dgageot force-pushed the dgageot:improve-docs-v3 branch from d4dc9bc to 16d6c4f Feb 21, 2019
@dgageot

This comment has been minimized.

Copy link
Member Author

dgageot commented Feb 21, 2019

Let me fix the typo

@dgageot

This comment has been minimized.

Copy link
Member 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
3 of 4 checks passed
3 of 4 checks passed
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
cla/google All necessary CLAs are signed
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
kokoro CI build successful.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.