docs: reorder skaffold debug docs
#6894
Merged
Conversation
This file contains hidden or 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
gsquared94
added
the
docs-modifications
|
Please visit http://34.94.139.93:1313 to view changes to the docs. |
container-tools-bot
removed
the
docs-modifications
briandealwis
approved these changes
Nov 22, 2021
Comment on lines
+226
to
+229
| ## Supported Language Runtimes | ||
|
|
||
| This section describes how `debug` recognizes the language runtime used in a | ||
| container image for specific language runtimes. |
There was a problem hiding this comment.
Rather than splitting this section out, why don't we integrate it into the previous tabs. Users of most of the runtimes will have to look into this sections if only to ensure they set the right environment variables.
There was a problem hiding this comment.
I wanted to separate this out because this section is independently relevant to Cloud Code. So when debug isn't working in Cloud Code for a language runtime they can link this section directly. Having it merged with the previous section would present additional info that IDE users don't necessarily need to know immediately.
Co-authored-by: Brian de Alwis <[email protected]>
Co-authored-by: Brian de Alwis <[email protected]>
Co-authored-by: Brian de Alwis <[email protected]>
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.
Fixes: #6691
Description
This PR reorders sections of the
Debuggingdocumentation page.The original writeup lacked a simple introduction. Also sections describing the language runtime detection heuristics was intertwined with the debugger setup information that made it difficult to parse the relevant information about heuristics separately. It also made it difficult to add a
debugging with Cloud Codesection since heuristic setup is still required for that, and it only automates parts of working with the debugger set up.See: http://34.94.139.93:1313/docs/workflows/debug/