Skaffold API docs #3068
Merged
Skaffold API docs #3068
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tejal29
added
the
docs-modifications
|
Please visit http://35.236.0.111:1313 to view changes to the docs. |
container-tools-bot
removed
the
docs-modifications
balopat
reviewed
Oct 16, 2019
balopat
reviewed
Oct 16, 2019
balopat
reviewed
Oct 16, 2019
tejal29
requested review from
dgageot,
nkubala and
priyawadhwa
as code owners
tejal29
force-pushed
the
events_api_docs
branch
from
d036e31 to
6de580f
Compare
feloy
reviewed
Oct 16, 2019
Codecov Report
|
nkubala
reviewed
Oct 16, 2019
balopat
reviewed
Oct 16, 2019
balopat
added
docs-modifications
|
Error creating deployment, please see controller logs for details. |
container-tools-bot
removed
the
docs-modifications
|
Please visit http://35.236.87.39:1313 to view changes to the docs. |
|
Error creating deployment, please see controller logs for details. |
balopat
suggested changes
Oct 17, 2019
There was a problem hiding this comment.
Added some more notes.
I would recommend the following renames for the titles:
background info -- same as you have it
## Connecting to the Skaffold API
### HTTP server
... try it out ...
describe the HTTP port setting
### gRPC server
...
## API structure
### Event stream
### Retrieve State
### Controlling Build/Sync/Deploy
nick's suggestion. Co-Authored-By: Nick Kubala <[email protected]>
Co-Authored-By: Balint Pato <[email protected]>
Co-Authored-By: Balint Pato <[email protected]>
dgageot
previously requested changes
Oct 31, 2019
Added proto description and code snippets
tejal29
force-pushed
the
events_api_docs
branch
from
6574f64 to
10f456c
Compare
tejal29
added
docs-modifications
|
Please visit http://34.94.43.151:1313 to view changes to the docs. |
container-tools-bot
removed
the
docs-modifications
balopat
approved these changes
Nov 1, 2019
nkubala
reviewed
Nov 1, 2019
|
|
||
| To retrieve information of the Skaffold pipeline, the Skaffold API provides two main functionalities: | ||
|
|
||
| * A [streaming event log]({{< relref "/docs/concepts/api#events-api">}}) created from the different phases in a pipeline run and |
There was a problem hiding this comment.
Suggested change
| * A [streaming event log]({{< relref "/docs/concepts/api#events-api">}}) created from the different phases in a pipeline run and | |
| * A [streaming event log]({{< relref "/docs/concepts/api#events-api">}}) created from the different phases in a pipeline run, and |
There was a problem hiding this comment.
there is usually no comma before and right?
There was a problem hiding this comment.
in this case since these are numbered items in a list, i think there should be one there. its nitpicky though
| * A snapshot of the [overall state]({{< relref "/docs/concepts/api#state-api" >}}) of the pipeline at any given time during the run. | ||
|
|
||
| To control the individual phases of the Skaffold, the Skaffold API provides [fine grained control over]({{< relref "/docs/concepts/api#controlling-build-sync-deploy" >}}) | ||
| the individual phases of the pipeline (build, deploy and sync). |
There was a problem hiding this comment.
Suggested change
| the individual phases of the pipeline (build, deploy and sync). | |
| the individual phases of the pipeline (sync, build, and deploy). |
There was a problem hiding this comment.
i will keep this as build, deploy and sync.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relates to #3023
Should merge after : #3065, #3067
Description
Organizing event api docs.
User facing changes
yes
Before
After
Next PRs.
n/a
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
See the contribution guide for more details.
Reviewer Notes
Release Notes