[docs] add init docs by tejal29 · Pull Request #3149 · GoogleContainerTools/skaffold

tejal29 · 2019-11-01T18:50:21Z

Fixes #2951

Should merge before : list any PRs that depend on this PR

Should merge after : list any PRs that are prerequisites to this PR

Description

User facing changes

yes,

Quickstart what's next points to getting started with your project
A new getting started with your project doc.
Fixed Buildpacks 404.

Next PRs.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

Includes unit tests
Mentions any output changes.
Adds documentation as needed: user docs, YAML reference, CLI reference.
Adds integration tests if needed.

Reviewer Notes

The code flow looks good.
Unit test added.
User facing changes look good.

Release Notes

container-tools-bot · 2019-11-01T18:52:17Z

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

codecov · 2019-11-01T19:04:03Z

Codecov Report

Merging #3149 into master will decrease coverage by 0.03%.
The diff coverage is n/a.

Impacted Files	Coverage Δ
pkg/skaffold/util/tar.go	`43.61% <0%> (-4.26%)`	⬇️

balopat

There are two things mixed here:

a.) skaffold init functionality spec
b.) getting started workflow

In my mind tutorials rely on essential features and refer to them, not introduce them. So this is not a tutorial. I think a.) should be it's own doc probably under "Skaffold Pipeline Stages" - at one point init might become an automated piece as well!!! b.) should be under "Working with Skaffold" (after "Common Workflows" is renamed)

docs/content/en/docs/tutorials/getting-started-with-your-project.md

Co-Authored-By: Balint Pato <balopat@users.noreply.github.com>

container-tools-bot · 2019-11-01T22:49:08Z

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

docs/content/en/docs/pipeline-stages/init.md

docs/content/en/docs/design/api.md

docs/content/en/docs/pipeline-stages/builders.md

docs/content/en/docs/workflows/getting-started-with-your-project.md

docs/content/en/docs/pipeline-stages/init.md

Co-Authored-By: Balint Pato <balopat@users.noreply.github.com>

…nto add_init_docs

container-tools-bot · 2019-11-04T21:41:18Z

Error creating deployment, please see controller logs for details.

container-tools-bot · 2019-11-04T21:42:08Z

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

container-tools-bot · 2019-11-04T21:42:09Z

Error creating deployment, please see controller logs for details.

container-tools-bot · 2019-11-04T21:57:07Z

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

container-tools-bot · 2019-11-04T23:06:34Z

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

balopat · 2019-11-04T17:31:55Z

docs/content/en/docs/pipeline-stages/init.md

+
+You can try it this out on example [jib project](https://github.com/GoogleContainerTools/skaffold/tree/master/examples/jib-multimodule)
+```bash
+$cd examples/jib-multimodule


screenshot instead of code block

balopat · 2019-11-04T22:58:52Z

docs/content/en/docs/workflows/getting-started-with-your-project.md

+
+For more understanding on how init works, see [`skaffold init`]({{<relref "/docs/pipeline-stages/init" >}})
+
+Try out [dev]({{<relref "/docs/workflows/dev" >}}), [debug]({{<relref "/docs/workflows/debug" >}}) workflows.


Suggested change

Try out [dev]({{<relref "/docs/workflows/dev" >}}), [debug]({{<relref "/docs/workflows/debug" >}}) workflows.

Try out [developing with Skaffold with hot reload]({{<relref "/docs/workflows/dev" >}}), or [debugging your apps with Skaffold on cluster]({{<relref "/docs/workflows/debug" >}}).

tejal29 requested review from balopat, dgageot and nkubala as code owners November 1, 2019 18:50

googlebot added the cla: yes label Nov 1, 2019

pull-request-size bot added the size/M label Nov 1, 2019

balopat added the docs-modifications runs the docs preview service on the given PR label Nov 1, 2019

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

balopat suggested changes Nov 1, 2019

View reviewed changes

docs/content/en/docs/tutorials/getting-started-with-your-project.md Outdated Show resolved Hide resolved

docs/content/en/docs/tutorials/getting-started-with-your-project.md Outdated Show resolved Hide resolved

tejal29 and others added 3 commits November 1, 2019 14:38

init docs

b0d98b1

Apply suggestions from code review

ac93cfb

Co-Authored-By: Balint Pato <balopat@users.noreply.github.com>

separate the docs

68e5b48

tejal29 force-pushed the add_init_docs branch from ce33898 to 68e5b48 Compare November 1, 2019 22:45

tejal29 added the docs-modifications runs the docs preview service on the given PR label Nov 1, 2019

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

balopat reviewed Nov 4, 2019

View reviewed changes

docs/content/en/docs/pipeline-stages/init.md Show resolved Hide resolved

balopat suggested changes Nov 4, 2019

View reviewed changes

balopat added the priority/p0 Highest priority. We are actively looking at delivering it. label Nov 4, 2019

tejal29 and others added 6 commits November 4, 2019 10:52

Update docs/content/en/docs/design/api.md

d037e8c

Co-Authored-By: Balint Pato <balopat@users.noreply.github.com>

Apply suggestions from code review

2997fb6

Co-Authored-By: Balint Pato <balopat@users.noreply.github.com>

Apply suggestions from code review

ca6bdf1

Co-Authored-By: Balint Pato <balopat@users.noreply.github.com>

wip

1bc69be

Merge branch 'add_init_docs' of https://github.com/tejal29/skaffold i…

b354000

…nto add_init_docs

add screen shots

270092b

tejal29 requested review from briandealwis, chanseokoh and loosebazooka as code owners November 4, 2019 19:39

tejal29 requested a review from TadCordle as a code owner November 4, 2019 19:39

tejal29 changed the title ~~init docs~~ [docs] add init docs Nov 4, 2019

change command screen shot

a687279

balopat added the docs-modifications runs the docs preview service on the given PR label Nov 4, 2019

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

minor changes

46ce84b

tejal29 added the docs-modifications runs the docs preview service on the given PR label Nov 4, 2019

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

remove try

c708ffa

tejal29 added the docs-modifications runs the docs preview service on the given PR label Nov 4, 2019

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

Merge branch 'master' into add_init_docs

8eb8dfb

balopat added the needs-rebase label Nov 5, 2019

balopat added 2 commits November 4, 2019 23:24

Merge branch 'master' into add_init_docs

cd6247c

newline

dea39b4

balopat approved these changes Nov 5, 2019

View reviewed changes

balopat merged commit e9225b1 into GoogleContainerTools:master Nov 5, 2019

tejal29 deleted the add_init_docs branch April 15, 2021 07:33


		For more understanding on how init works, see [`skaffold init`]({{<relref "/docs/pipeline-stages/init" >}})

		Try out [dev]({{<relref "/docs/workflows/dev" >}}), [debug]({{<relref "/docs/workflows/debug" >}}) workflows.

	Try out [dev]({{<relref "/docs/workflows/dev" >}}), [debug]({{<relref "/docs/workflows/debug" >}}) workflows.
	Try out [developing with Skaffold with hot reload]({{<relref "/docs/workflows/dev" >}}), or [debugging your apps with Skaffold on cluster]({{<relref "/docs/workflows/debug" >}}).

Conversation

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

Uh oh!

Uh oh!

container-tools-bot commented Nov 1, 2019

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

balopat left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

container-tools-bot commented Nov 1, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

container-tools-bot commented Nov 4, 2019

Uh oh!

container-tools-bot commented Nov 4, 2019

Uh oh!

container-tools-bot commented Nov 4, 2019

Uh oh!

container-tools-bot commented Nov 4, 2019

Uh oh!

container-tools-bot commented Nov 4, 2019

Uh oh!

balopat Nov 4, 2019

Choose a reason for hiding this comment

Uh oh!

balopat Nov 4, 2019

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tejal29 commented Nov 1, 2019 •

edited

Loading

codecov bot commented Nov 1, 2019 •

edited

Loading