-
Notifications
You must be signed in to change notification settings - Fork 42
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
clean: Create a dedicated section for the service account procedure DOCS-680 #2103
Conversation
Overall readability score: 53.99 (🔴 -0.06)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
To fix this issue and avoid future disruptions, refresh the GitLab or Bitbucket integration on Codacy using a dedicated service account on your Git provider: | ||
To fix this issue and avoid future disruptions, refresh the GitLab or Bitbucket integration on Codacy [using a dedicated service account](#service-account) on your Git provider. | ||
|
||
## Using a dedicated service account to integrate with your Git provider {: id="service-account"} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nicklem This is the option of isolating the service account procedure on a dedicated section within the same troubleshooting page.
However, I decided to try out a second option - isolating the procedure on a dedicated page. 🤓
The page title is a bit long, but it might work... Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea of the separate page, but for completeness, I'd also add one sentence to explain the concept of "service account" (e.g., I like this explanation). I didn't even know it had a name 😅
Create a dedicated section for the service account procedure Add documentation on using a dedicated service account
This pull request adds a new dedicated section on the documentation website for using a dedicated service account to integrate Codacy with your repositories. This change prevents disruption of service if the user who originally enabled the integration loses access to the repositories. The documentation now includes instructions on how to set up a dedicated service account and how to integrate Codacy with GitLab or Bitbucket using this account. This comment was generated by an experimental AI tool (winner of the 2024 Codacy Hackathon 'People's Choice' and 'Most Valuable' awards). |
Closing this one for now. |
Isolates the instructions for using a dedicated service account to integrate with the Git provider in a dedicated section so that it can be easily referred to.
👀 Live preview
https://docs-680-dedicated-service-account--docs-codacy.netlify.app/faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests/#service-account