Skip to content

Conversation

@mrnugget
Copy link
Contributor

@mrnugget mrnugget commented Feb 1, 2021

This fixes https://github.com/sourcegraph/sourcegraph/issues/17259, but
contrary to what I stated in the original ticket, I think it makes more
sense to always link to these docs.

Why?

  1. It's two lines. It doesn't hurt.
  2. It's really tricky to find out exactly when to link to the docs and
    when not. Especially since running the steps could result in an error
    that could be fixed through the troubleshooting guide (example:
    broken docker setup).

Screenshots

screenshot_2021-02-01_16 24 59@2x

screenshot_2021-02-01_16 25 28@2x

This fixes https://github.com/sourcegraph/sourcegraph/issues/17259, but
contrary to what I stated in the original ticket, I think it makes more
sense to always link to these docs.

Why?

1. It's two lines. It doesn't hurt.
2. It's really tricky to find out exactly when to link to the docs and
   when not. Especially since running the steps could result in an error
   that could be fixed through the troubleshooting guide (example:
   broken docker setup).
@mrnugget mrnugget requested a review from a team February 1, 2021 15:30
@mrnugget mrnugget merged commit e036554 into main Feb 1, 2021
@mrnugget mrnugget deleted the mrn/link-to-troubleshooting-docs branch February 1, 2021 16:02
scjohns pushed a commit that referenced this pull request Apr 24, 2023
)

This fixes https://github.com/sourcegraph/sourcegraph/issues/17259, but
contrary to what I stated in the original ticket, I think it makes more
sense to always link to these docs.

Why?

1. It's two lines. It doesn't hurt.
2. It's really tricky to find out exactly when to link to the docs and
   when not. Especially since running the steps could result in an error
   that could be fixed through the troubleshooting guide (example:
   broken docker setup).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Link to troubleshooting docs when src-cli outputs an error that's not a step-failed-with-non-zero-exit-code error

3 participants