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

[docs] add init docs #3149

Merged
merged 15 commits into from Nov 5, 2019
Merged

[docs] add init docs #3149

merged 15 commits into from Nov 5, 2019

Conversation

@tejal29
Copy link
Member

tejal29 commented Nov 1, 2019

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,

  1. Quickstart what's next points to getting started with your project
  2. A new getting started with your project doc.
  3. 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

This comment has been minimized.

Copy link

container-tools-bot commented Nov 1, 2019

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

@codecov

This comment has been minimized.

Copy link

codecov bot commented Nov 1, 2019

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%) ⬇️
Copy link
Collaborator

balopat left a comment

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)

tejal29 and others added 3 commits Nov 1, 2019
Co-Authored-By: Balint Pato <balopat@users.noreply.github.com>
@tejal29 tejal29 force-pushed the tejal29:add_init_docs branch from ce33898 to 68e5b48 Nov 1, 2019
@container-tools-bot

This comment has been minimized.

Copy link

container-tools-bot commented Nov 1, 2019

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

docs/content/en/docs/pipeline-stages/init.md Outdated Show resolved Hide resolved
docs/content/en/docs/pipeline-stages/init.md Outdated Show resolved Hide resolved
docs/content/en/docs/pipeline-stages/init.md Outdated Show resolved Hide resolved
@balopat balopat added the priority/p0 label Nov 4, 2019
tejal29 and others added 6 commits Nov 4, 2019
Co-Authored-By: Balint Pato <balopat@users.noreply.github.com>
Co-Authored-By: Balint Pato <balopat@users.noreply.github.com>
Co-Authored-By: Balint Pato <balopat@users.noreply.github.com>
wip
…nto add_init_docs
@tejal29 tejal29 requested a review from TadCordle as a code owner Nov 4, 2019
@tejal29 tejal29 changed the title init docs [docs] add init docs Nov 4, 2019
@container-tools-bot

This comment has been minimized.

Copy link

container-tools-bot commented Nov 4, 2019

Error creating deployment, please see controller logs for details.

@container-tools-bot

This comment has been minimized.

Copy link

container-tools-bot commented Nov 4, 2019

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

@container-tools-bot

This comment has been minimized.

Copy link

container-tools-bot commented Nov 4, 2019

Error creating deployment, please see controller logs for details.

@container-tools-bot

This comment has been minimized.

Copy link

container-tools-bot commented Nov 4, 2019

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

@container-tools-bot

This comment has been minimized.

Copy link

container-tools-bot commented Nov 4, 2019

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

@balopat balopat added the needs-rebase label Nov 5, 2019
balopat added 2 commits Nov 5, 2019
@balopat
balopat approved these changes Nov 5, 2019

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

This comment has been minimized.

Copy link
@balopat

balopat Nov 5, 2019

Collaborator

screenshot instead of code block


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.

This comment has been minimized.

Copy link
@balopat

balopat Nov 5, 2019

Collaborator
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" >}}).
@balopat balopat merged commit e9225b1 into GoogleContainerTools:master Nov 5, 2019
3 checks passed
3 checks passed
Travis CI - Pull Request Build Passed
Details
cla/google All necessary CLAs are signed
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
4 participants
You can’t perform that action at this time.