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

add Troubleshooting section for GitHub page #294

Closed
wants to merge 1 commit into from
Closed

add Troubleshooting section for GitHub page #294

wants to merge 1 commit into from

Conversation

bolinfest
Copy link
Contributor

@bolinfest bolinfest commented Dec 1, 2022

Stack created with Sapling. Best reviewed with ReviewStack.

add Troubleshooting section for GitHub page

I just ran into an issue where sl pr failed to run because I
did not have gh configured as my Git credential helper.
It took me a bit of time to figure this out, so I thought I would
add it to the website, though the docs related to GitHub
integration are somewhat spread out, so I'm not sure whether this
is the best place for it. A dedicated Troubleshooting page might
be more appropriate, though such a page should probably have at
least two entries?

Though perhaps an even better solution is updating the code to
recognize this sort of failure and then suggest gh auth setup-git
directly when it happens.

Test Plan:

http://localhost:3000/docs/git/intro

I just ran into an issue where `sl pr` failed to run because I
did not have `gh` configured as my Git credential helper.
It took me a bit of time to figure this out, so I thought I would
add it to the website, though the docs related to GitHub
integration are somewhat spread out, so I'm not sure whether this
is the best place for it. A dedicated Troubleshooting page might
be more appropriate, though such a page should probably have at
least two entries?

Though perhaps an even better solution is updating the code to
recognize this sort of failure and then suggest `gh auth setup-git`
directly when it happens.

Test Plan:

http://localhost:3000/docs/git/intro
@facebook-github-bot
Copy link
Contributor

@bolinfest has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

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.

2 participants