more fixing tips #399
more fixing tips #399
Conversation
| --- | ||
|
|
||
| Sometimes there is an error when Prophecy tries to reach Git. This could be caused by your user's [authorization](#debugging-git-credentials), a [repository setting](#debugging-repository-setttings), or a [network](#debugging-network-issues) issue. Fear not! This guide outlines what to do if you see error messages such as: | ||
| `not authorized` |
There was a problem hiding this comment.
nit: to make it easier to read in this file, add empty spaces, so:
This guide outlines what to do if you see error messages such as:
not authorized
git-upload-pack-not-permitted
or
git-recieve-pack-not-permitted
There was a problem hiding this comment.
Or better yet, use an unordered list for these, so:
- not authorized
- git-upload-pack-not-permitted
- git-recieve-pack-not-permitted
| @@ -0,0 +1,57 @@ | |||
| --- | |||
| title: Git Troubleshooting | |||
There was a problem hiding this comment.
nit: are you okay with using sentence casing for titles and section headers? We have a mix of either that or title case in our docset, and I want to start enforcing one for consistency.
Git troubleshooting
Debugging Git credentials
Debugging network issues
|
|
||
| Sometimes your personal access token (PAT) has expired or lacks a certain permission. | ||
|
|
||
| 1. Check if your PAT has expired. If so, create a new one with sufficient read and write access to the repository of interest. Here are the instructions to locate existing tokens and create new tokens for [Github](https://docs.github.com/en/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens), [Bitbucket](https://support.atlassian.com/bitbucket-cloud/docs/repository-access-tokens/), or [GitLab](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token). |
There was a problem hiding this comment.
Should be mention where the reader can check to see if their PAT has expired?
There was a problem hiding this comment.
Is it the Prophecy Access Tokens tab?
| tags: [] | ||
| --- | ||
|
|
||
| Sometimes there is an error when Prophecy tries to reach Git. This could be caused by your user's [authorization](#debugging-git-credentials), a [repository setting](#debugging-repository-setttings), or a [network](#debugging-network-issues) issue. Fear not! This guide outlines what to do if you see error messages such as: |
There was a problem hiding this comment.
We should use second person, so "This could be cause by your [authorization]..."
|
|
||
| 1. Check if your PAT has expired. If so, create a new one with sufficient read and write access to the repository of interest. Here are the instructions to locate existing tokens and create new tokens for [Github](https://docs.github.com/en/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens), [Bitbucket](https://support.atlassian.com/bitbucket-cloud/docs/repository-access-tokens/), or [GitLab](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token). | ||
| 2. Open a terminal from a computer that can access your Git repository. If you need help with this step, please reach out to your Git administrator. | ||
| 3. Have the new PAT ready; you'll use it in place of a password. |
There was a problem hiding this comment.
If the reader doesn't have a new PAT, should we tell them where/how they can create one? Or link them to https://docs.prophecy.io/metadata/prophecyAPI/#generate-a-pat
| 1. Check if your PAT has expired. If so, create a new one with sufficient read and write access to the repository of interest. Here are the instructions to locate existing tokens and create new tokens for [Github](https://docs.github.com/en/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens), [Bitbucket](https://support.atlassian.com/bitbucket-cloud/docs/repository-access-tokens/), or [GitLab](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token). | ||
| 2. Open a terminal from a computer that can access your Git repository. If you need help with this step, please reach out to your Git administrator. | ||
| 3. Have the new PAT ready; you'll use it in place of a password. | ||
| 4. Check for read access by testing your ability to [clone](https://git-scm.com/docs/git-clone) a repo |
There was a problem hiding this comment.
For 4. and 5. I would add :'s at the end of the statements. And maybe use code blocks for better formatting and easier copy/paste-ability
|
|
||
| ## Debugging Repository Settings | ||
|
|
||
| Sometimes a repository settings can restrict a user's permissions outside the user's profile settings page. |
There was a problem hiding this comment.
"...restrict your permissions"
|
|
||
| ## Debugging Repository Settings | ||
|
|
||
| Sometimes a repository settings can restrict a user's permissions outside the user's profile settings page. |
There was a problem hiding this comment.
I'm not sure where the reader would go to check the following restrictions. We could add a line saying something like, "On the repository's security settings, check for the following restrictions."
No description provided.