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

Rework debug docs #3875

Merged
merged 2 commits into from
Mar 26, 2020
Merged

Rework debug docs #3875

merged 2 commits into from
Mar 26, 2020

Conversation

briandealwis
Copy link
Member

Description

Some rototilling of the skaffold debug docs:

  • separate API and metadata description
  • document limitations of source roots

@quoctruong

- separate API and metadata description
- document limitations of source roots
@briandealwis briandealwis added docs-modifications runs the docs preview service on the given PR area/debug area/docs labels Mar 25, 2020
@container-tools-bot
Copy link

Error creating deployment, please see controller logs for details.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Mar 25, 2020
@container-tools-bot
Copy link

Error creating deployment, please see controller logs for details.

@container-tools-bot
Copy link

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

@container-tools-bot
Copy link

Error creating deployment, please see controller logs for details.

@codecov
Copy link

codecov bot commented Mar 25, 2020

Codecov Report

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

@dgageot dgageot self-assigned this Mar 26, 2020
Copy link
Contributor

@dgageot dgageot left a comment

Choose a reason for hiding this comment

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

LGTM with a nit

`ports` is a list of debug ports keyed by the language runtime debugging protocol.
`workingDir` is the working directory (if not an empty string).
`skaffold debug` examines the built artifacts to determine the underlying language runtime technology.
All Kubernetes manifests that references these artifacts are transformed on-the-fly to enable the
Copy link
Contributor

Choose a reason for hiding this comment

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

reference?

@briandealwis briandealwis merged commit eaf5b88 into master Mar 26, 2020
@briandealwis briandealwis deleted the briandealwis-patch-3 branch March 26, 2020 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants