doc: improve Catalina discoverability for search engines #2135
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
By showing the error in the guide, search engines should be able to find this document when users search for specific lines from the error.
cclauss
changed the title
cclauss
reviewed
May 19, 2020
macOS_Catalina.md
Outdated
Comment on lines
8
to
20
| No receipt for 'com.apple.pkg.CLTools_Executables' found at '/'. | ||
|
|
||
| No receipt for 'com.apple.pkg.DeveloperToolsCLILeo' found at '/'. | ||
|
|
||
| No receipt for 'com.apple.pkg.DeveloperToolsCLI' found at '/'. | ||
|
|
||
| gyp: No Xcode or CLT version detected! | ||
| gyp ERR! configure error | ||
| gyp ERR! stack Error: `gyp` failed with exit code: 1 | ||
| gyp ERR! stack at ChildProcess.onCpExit (/Users/wtodd/.nvm/versions/node/v13.10.1/lib/node_modules/npm/node_modules/node-gyp/lib/configure.js:351:16) | ||
| gyp ERR! stack at ChildProcess.emit (events.js:316:20) | ||
| gyp ERR! stack at Process.ChildProcess._handle.onexit (internal/child_process.js:275:12) | ||
| gyp ERR! System Darwin 19.4.0 |
There was a problem hiding this comment.
Suggested change
| No receipt for 'com.apple.pkg.CLTools_Executables' found at '/'. | |
| No receipt for 'com.apple.pkg.DeveloperToolsCLILeo' found at '/'. | |
| No receipt for 'com.apple.pkg.DeveloperToolsCLI' found at '/'. | |
| gyp: No Xcode or CLT version detected! | |
| gyp ERR! configure error | |
| gyp ERR! stack Error: `gyp` failed with exit code: 1 | |
| gyp ERR! stack at ChildProcess.onCpExit (/Users/wtodd/.nvm/versions/node/v13.10.1/lib/node_modules/npm/node_modules/node-gyp/lib/configure.js:351:16) | |
| gyp ERR! stack at ChildProcess.emit (events.js:316:20) | |
| gyp ERR! stack at Process.ChildProcess._handle.onexit (internal/child_process.js:275:12) | |
| gyp ERR! System Darwin 19.4.0 | |
| gyp: No Xcode or CLT version detected! |
My sense is that this error message should be sufficient. The other lines might might change in different environments ("/Users/wtodd", etc.).
There was a problem hiding this comment.
We should also mark this class of issues with the gyp: No Xcode or CLT version detected! label.
There was a problem hiding this comment.
Accepted your suggestion, but, what about using this instead:
No receipt for 'com.apple.pkg.CLTools_Executables' found at '/'.
No receipt for 'com.apple.pkg.DeveloperToolsCLILeo' found at '/'.
No receipt for 'com.apple.pkg.DeveloperToolsCLI' found at '/'.
gyp: No Xcode or CLT version detected!
I can imagine folks searching for the first three lines as well (not everyone will know which lines are the most relevant to search for). Agreed that the last ones are platform dependent (I thought I changed those before committing 😛)
cclauss
approved these changes
May 19, 2020
rvagg
pushed a commit
that referenced
this pull request
May 26, 2020
By showing the error in the guide, search engines should be able to find this document when users search for specific lines from the error. Co-authored-by: Christian Clauss <cclauss@me.com> PR-URL: #2135 Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Christian Clauss <cclauss@me.com>
Closed
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.
By showing the error in the guide, search engines should be able to find
this document when users search for specific lines from the error.
Checklist