Add docs and tutorial for buildpacks by priyawadhwa · Pull Request #2879 · GoogleContainerTools/skaffold

priyawadhwa · 2019-09-13T20:03:31Z

Add docs with tutorial for using skaffold with buildpacks via
the custom builder.

depends on #2893 (merged)

Add docs and tutorial for using skaffold with buildpacks via the custom builder.

codecov · 2019-09-13T20:17:23Z

Codecov Report

Merging #2879 into master will not change coverage.
The diff coverage is n/a.

Impacted Files	Coverage Δ
pkg/skaffold/server/server.go	`58.57% <0%> (ø)`	⬆️

container-tools-bot · 2019-09-13T21:53:29Z

Error creating deployment docs-controller-deployment-2879, please visit https://storage.googleapis.com/webhook-logs/logs-2879-1568411607494563296 to view logs.

tejal29

I added the label docs-modifications to see the changes, but looks like its broken due to #2884

Great start! some nits.
Will check again when docs are generated.

docs/content/en/docs/how-tos/buildpacks/_index.md

container-tools-bot · 2019-09-13T22:40:36Z

Error creating deployment docs-controller-deployment-2879, please visit https://storage.googleapis.com/webhook-logs/logs-2879-1568414435741304973 to view logs.

container-tools-bot · 2019-09-14T06:37:02Z

Error creating deployment docs-controller-deployment-2879, please visit https://storage.googleapis.com/webhook-logs/logs-2879-1568443021185774710 to view logs.

tejal29 · 2019-09-16T17:09:35Z

@priyawadhwa Please rebase so we can check if #2884 fixed the issue

tejal29 · 2019-09-16T17:10:32Z

There is another error

Error: Error building site: "/app/docs/content/en/docs/how-tos/buildpacks/_index.md:37:1": failed to 
render shortcode "readfile": failed to process shortcode: 
"/app/docs/layouts/shortcodes/readfile.html:1:47": execute of template failed: template: 
shortcodes/readfile.html:1:47: executing "shortcodes/readfile.html" at <readFile>: error calling 
readFile: file "samples/buildpacks/Skaffold.yaml" does not exist

…o buildpacks-docs

container-tools-bot · 2019-09-16T18:36:42Z

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

priyawadhwa · 2019-09-16T19:37:41Z

Hey @tejal29 -- incorporated your changes PTAL

container-tools-bot · 2019-09-16T19:43:15Z

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

container-tools-bot · 2019-09-16T19:52:09Z

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

container-tools-bot · 2019-09-16T19:52:51Z

Error creating deployment docs-controller-deployment-2879, please visit https://storage.googleapis.com/webhook-logs/logs-2879-1568663570220304046 to view logs.

container-tools-bot · 2019-09-16T19:52:52Z

Error creating deployment, please see controller logs for details.

tejal29

Sorry, just a few more nits.

I am trying to see if we can make this tutorial as complete as possible.
If a user is landing on this page directly. (via google search results)

It would be good to link skaffold's getting started doc.
E.g. See https://cloud.google.com/go/getting-started/tutorial-app#before-you-begin

You can either,
Explicitly mention,

Before you being, please see our getting started guide at http://skaffold.dev/docs/getting-started/#before-you-begin
Or, like this page https://cloud.google.com/go/getting-started/using-structured-data
See how they mention

This page is part of a multi-page tutorial. 
To start from the beginning and read the setup instructions, go to Go Bookshelf app.

We can also do something similar and say

This page describes how to use Buildpacks with skaffold. 
To learn more about how to set up skaffold, see http://skaffold.dev/docs/getting-started

I don't mind either approach.

We should also have "Before you begin" Section and explicitly mention installing pack and docker.
Some users might skip it because its not mentioned :)

And then finally, a section on Cleaning Up.

tejal29 · 2019-09-16T20:03:01Z

docs/content/en/docs/how-tos/buildpacks/_index.md

+
+## Tutorial
+
+Clone the Skaffold buildpacks [example](https://github.com/GoogleContainerTools/Skaffold/blob/master/examples/buildpacks/) for sample code.


Lets try to add a one line description on what the example does so that user's know what they are installing.
e.g. https://cloud.google.com/go/getting-started/tutorial-app

Suggested change

Clone the Skaffold buildpacks [example](https://github.com/GoogleContainerTools/Skaffold/blob/master/examples/buildpacks/) for sample code.

In this tutorial, you will deploy a single go based file app on a pod.

Clone the Skaffold buildpacks [example](https://github.com/GoogleContainerTools/Skaffold/blob/master/examples/buildpacks/) for sample code.

tejal29 · 2019-09-16T20:04:13Z

docs/content/en/docs/how-tos/buildpacks/_index.md

+```shell
+$ skaffold run --tail --default-repo <your repo>
+```
+This will deploy Hello World in Go to your cluster.


Do we have cluster step up steps somewhere that we can point users to if they have never set up a cluster kubectl ?

I think the getting-started guide might have it. If not we shd add it there.
Maybe we can do that in a separate PR.

tejal29 · 2019-09-16T20:44:37Z

@priyawadhwa Can you also please break this PR into 2.

one with no user impact and just example.
- Every example in examples/ should be tested. So we should add test it.
Actual docs changes

This could be an example on how to add break docs into smaller changes.

thanks
Tejal

…o buildpacks-docs

priyawadhwa · 2019-09-17T17:46:46Z

@tejal29 thanks for the feedback, I've incorporated it --- PTAL!

tejal29 · 2019-09-17T23:02:50Z

cool. @priyawadhwa changes looks great! will take a look at the generated docs.

container-tools-bot · 2019-09-17T23:03:39Z

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

tejal29 · 2019-09-17T23:52:19Z

docs/content/en/docs/how-tos/buildpacks/_index.md

+$ pack set-default-builder heroku/buildpacks
+```
+
+Take a look at the `build.sh` file, which uses `pack` to containerize source code with buildpacks:


Can you also link the http://skaffold.dev/docs/how-tos/builders/#custom-build-script-run-locally here. I think users might need help on what $image and $PUSH_IMAGE is.

tejal29 · 2019-09-17T23:56:46Z

docs/content/en/docs/how-tos/buildpacks/_index.md

+```shell
+$ skaffold run --tail --default-repo <your repo>
+```
+With this command, Skaffold will build `gcr.io/k8s-skaffold/skaffold-example` with buildpacks and deploy the application to Kubernetes.


nit: k8s-skaffold will be replaced by <your repo>

Add docs and tutorial for buildpacks

aae7452

Add docs and tutorial for using skaffold with buildpacks via the custom builder.

priyawadhwa requested review from balopat, dgageot, nkubala and tejal29 as code owners September 13, 2019 20:03

googlebot added the cla: yes label Sep 13, 2019

add sample to examples too

8b6810d

tejal29 added the docs-modifications runs the docs preview service on the given PR label Sep 13, 2019

container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Sep 13, 2019

tejal29 suggested changes Sep 13, 2019

View reviewed changes

balopat added the docs-modifications runs the docs preview service on the given PR label Sep 13, 2019

container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Sep 13, 2019

balopat added the docs-modifications runs the docs preview service on the given PR label Sep 14, 2019

container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Sep 14, 2019

Priya Wadhwa added 2 commits September 16, 2019 11:29

code review suggestions

0b7e95f

Merge branch 'master' of github.com:GoogleContainerTools/skaffold int…

d5b8467

…o buildpacks-docs

priyawadhwa added the docs-modifications runs the docs preview service on the given PR label Sep 16, 2019

container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Sep 16, 2019

improvements

f6fd9b3

priyawadhwa force-pushed the buildpacks-docs branch from 74c1367 to f6fd9b3 Compare September 16, 2019 19:38

priyawadhwa added the docs-modifications runs the docs preview service on the given PR label Sep 16, 2019

container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Sep 16, 2019

priyawadhwa added the docs-modifications runs the docs preview service on the given PR label Sep 16, 2019

Moved tutorial to the top

54aa315

priyawadhwa force-pushed the buildpacks-docs branch from 01d165b to 54aa315 Compare September 16, 2019 19:49

priyawadhwa added docs-modifications runs the docs preview service on the given PR and removed docs-modifications runs the docs preview service on the given PR labels Sep 16, 2019

container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Sep 16, 2019

tejal29 suggested changes Sep 16, 2019

View reviewed changes

code review comments

7ac2736

priyawadhwa mentioned this pull request Sep 16, 2019

Add buildpacks example to be referenced in buildpacks docs #2893

Merged

Merge branch 'master' of github.com:GoogleContainerTools/skaffold int…

48986ac

…o buildpacks-docs

tejal29 added the docs-modifications runs the docs preview service on the given PR label Sep 17, 2019

container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Sep 17, 2019

tejal29 reviewed Sep 17, 2019

View reviewed changes

tejal29 approved these changes Sep 17, 2019

View reviewed changes

code review comments

926ba61

tejal29 approved these changes Sep 18, 2019

View reviewed changes

tejal29 merged commit dd34038 into GoogleContainerTools:master Sep 18, 2019

priyawadhwa deleted the buildpacks-docs branch September 18, 2019 17:37


		## Tutorial

		Clone the Skaffold buildpacks [example](https://github.com/GoogleContainerTools/Skaffold/blob/master/examples/buildpacks/) for sample code.

	Clone the Skaffold buildpacks [example](https://github.com/GoogleContainerTools/Skaffold/blob/master/examples/buildpacks/) for sample code.
	In this tutorial, you will deploy a single go based file app on a pod.
	Clone the Skaffold buildpacks [example](https://github.com/GoogleContainerTools/Skaffold/blob/master/examples/buildpacks/) for sample code.

Conversation

priyawadhwa commented Sep 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Sep 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

container-tools-bot commented Sep 13, 2019

Uh oh!

tejal29 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

container-tools-bot commented Sep 13, 2019

Uh oh!

container-tools-bot commented Sep 14, 2019

Uh oh!

tejal29 commented Sep 16, 2019

Uh oh!

tejal29 commented Sep 16, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

container-tools-bot commented Sep 16, 2019

Uh oh!

priyawadhwa commented Sep 16, 2019

Uh oh!

container-tools-bot commented Sep 16, 2019

Uh oh!

container-tools-bot commented Sep 16, 2019

Uh oh!

container-tools-bot commented Sep 16, 2019

Uh oh!

container-tools-bot commented Sep 16, 2019

Uh oh!

tejal29 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tejal29 Sep 16, 2019

Choose a reason for hiding this comment

Uh oh!

tejal29 Sep 16, 2019

Choose a reason for hiding this comment

Uh oh!

tejal29 Sep 16, 2019

Choose a reason for hiding this comment

Uh oh!

tejal29 commented Sep 16, 2019

Uh oh!

priyawadhwa commented Sep 17, 2019

Uh oh!

tejal29 commented Sep 17, 2019

Uh oh!

container-tools-bot commented Sep 17, 2019

Uh oh!

tejal29 Sep 17, 2019

Choose a reason for hiding this comment

Uh oh!

tejal29 Sep 17, 2019

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

priyawadhwa commented Sep 13, 2019 •

edited

Loading

codecov bot commented Sep 13, 2019 •

edited

Loading

tejal29 commented Sep 16, 2019 •

edited

Loading

tejal29 left a comment •

edited

Loading