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.

Sign up for GitHub

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

Jump to bottom

Add docs for dev and ci/cd workflows #3153

Merged
merged 6 commits into from
Nov 4, 2019
Merged

Add docs for dev and ci/cd workflows #3153

merged 6 commits into from
Nov 4, 2019

Conversation

nkubala
Copy link
Contributor

@nkubala nkubala commented Nov 1, 2019

Fixes #3074

@codecov
Copy link

codecov bot commented Nov 1, 2019 •
edited
Loading

Codecov Report

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

@tejal29 tejal29 added the docs-modifications runs the docs preview service on the given PR label Nov 1, 2019
@container-tools-bot
Copy link

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

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Nov 1, 2019
@balopat balopat added the docs-modifications runs the docs preview service on the given PR label Nov 1, 2019
@container-tools-bot
Copy link

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

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Nov 1, 2019
@tejal29 tejal29 added the docs-modifications runs the docs preview service on the given PR label Nov 1, 2019
@container-tools-bot
Copy link

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

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Nov 1, 2019
@tejal29 tejal29 added the docs-modifications runs the docs preview service on the given PR label Nov 1, 2019
@container-tools-bot
Copy link

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

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Nov 1, 2019
@balopat balopat added the docs-modifications runs the docs preview service on the given PR label Nov 1, 2019
@balopat balopat 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 Nov 1, 2019
tejal29
tejal29 reviewed Nov 1, 2019
View reviewed changes
docs/content/en/docs/workflows/ci-cd.md Outdated Show resolved Hide resolved
docs/content/en/docs/workflows/dev.md Show resolved Hide resolved
docs/content/en/docs/workflows/dev.md Outdated Show resolved Hide resolved
docs/content/en/docs/workflows/dev.md Outdated
## Dev loop

When `skaffold dev` is run, Skaffold will first do a full build and deploy of all artifacts specified in the `skaffold.yaml`, identical behavior to `skaffold run`. Upon successful build and deploy, Skaffold will start watching all source file dependencies for all artifacts specified in the project. As changes are made to these source files, Skaffold will rebuild the associated artifacts, and redeploy the new changes to your cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

I dont think we have skaffold run documented any where. we can drop it or link to existing CLI doc on run.

docs/content/en/docs/workflows/dev.md Outdated Show resolved Hide resolved
docs/content/en/docs/workflows/dev.md Outdated Show resolved Hide resolved
docs/content/en/docs/workflows/dev.md Outdated Show resolved Hide resolved
docs/content/en/docs/workflows/dev.md


## Control API
Copy link
Contributor

@tejal29 tejal29 Nov 1, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

I think we should explain trigger types here and not control api.

Copy link
Contributor

Choose a reason for hiding this comment

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

also, I'm writing a section about the Control API :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just wanted to have a little section about it here for discoverability, and then link in the full docs to the control API. I mentioned the trigger types above this section. do you think I should remove this?

Copy link
Contributor

@balopat balopat Nov 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

I'd make it smaller and refer to Skaffold API as an advanced topic for those who want to integrate tools with skaffold dev or have finer grained control and point them to the /docs/design/api docs - it is not essential for the CLI users. WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

I agree, control API is not for CLI user and more of integration for tools.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sounds reasonable, I do think CLI users could still potentially make use of the control API, but it's not a first class feature. I cut down the blurb to just explain what it is and why you might use it, and then pointed to the API docs

@container-tools-bot
Copy link

Please visit http://35.235.117.222: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 Nov 1, 2019
@balopat balopat added the docs-modifications runs the docs preview service on the given PR label Nov 2, 2019
@container-tools-bot
Copy link

Please visit http://35.236.87.39: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 Nov 2, 2019
@balopat balopat added the priority/p0 Highest priority. We are actively looking at delivering it. label Nov 4, 2019
@balopat balopat added the docs-modifications runs the docs preview service on the given PR label Nov 4, 2019
@container-tools-bot
Copy link

Please visit http://34.94.185.45: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 Nov 4, 2019
@balopat
Copy link
Contributor

balopat commented Nov 4, 2019

:shipit: 🚢

@nkubala nkubala merged commit 22c108f into GoogleContainerTools:master Nov 4, 2019
@nkubala nkubala deleted the docs branch November 4, 2019 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tejal29 tejal29 tejal29 left review comments

@balopat balopat balopat approved these changes

@dgageot dgageot Awaiting requested review from dgageot

Assignees
No one assigned
Labels
cla: yes priority/p0 Highest priority. We are actively looking at delivering it. size/M
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Complete skaffold workflows documentation
5 participants
@nkubala @container-tools-bot @balopat @tejal29 @googlebot