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

Improve Debug's Go docs #3949

Merged
merged 2 commits into from
Apr 14, 2020
Merged

Improve Debug's Go docs #3949

merged 2 commits into from
Apr 14, 2020

Conversation

briandealwis
Copy link
Member

From user feedback:

  • "self-identify" is cryptic
  • note that the apps should not use Alpine/MUSL, and include the error message seen in such circumstances

@briandealwis
Improve Debug's Go docs
c22df6e 
- user feedback that "self-identify" is cryptic
- should not use Alpine/MUSL, and include odd error message
@briandealwis briandealwis added docs-modifications runs the docs preview service on the given PR area/docs labels Apr 14, 2020
dgageot
dgageot reviewed Apr 14, 2020
View reviewed changes
docs/content/en/docs/workflows/debug.md Outdated
- Go applications should be built without optimizations, so your build should be capable of building with
`-gcflags='all=-N -l'`. Skaffold [_Profiles_]({{< relref "/docs/environment/profiles.md" >}}) are a useful option.
- Alpine/MUSL-based apps are not supported at the moment, and usually results in cryptic errors like
Copy link
Contributor

Choose a reason for hiding this comment

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

s/results/result?

@container-tools-bot
Copy link

Error creating deployment, please see controller logs for details.

1 similar comment
@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 Apr 14, 2020
@container-tools-bot
Copy link

Error creating deployment, please see controller logs for details.

dgageot
dgageot approved these changes Apr 14, 2020
View reviewed changes
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 nit

@dgageot dgageot added the kokoro:run runs the kokoro jobs on a PR label Apr 14, 2020
@container-tools-bot
Copy link

Please visit http://34.94.251.4: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 Apr 14, 2020

Codecov Report

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

@kokoro-team kokoro-team removed the kokoro:run runs the kokoro jobs on a PR label Apr 14, 2020
@dgageot dgageot added the kokoro:run runs the kokoro jobs on a PR label Apr 14, 2020
@briandealwis briandealwis merged commit 66da664 into master Apr 14, 2020
@briandealwis briandealwis deleted the briandealwis-patch-3 branch April 14, 2020 15:58
@fmotrifork fmotrifork mentioned this pull request Apr 20, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dgageot dgageot dgageot approved these changes

@balopat balopat Awaiting requested review from balopat

@nkubala nkubala Awaiting requested review from nkubala

@tejal29 tejal29 Awaiting requested review from tejal29

Assignees
No one assigned
Labels
area/docs cla: yes kokoro:run runs the kokoro jobs on a PR size/S
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@briandealwis @container-tools-bot @dgageot @googlebot @kokoro-team