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鈥檒l 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

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

claudiacarpinteiro
Copy link
Contributor

@claudiacarpinteiro claudiacarpinteiro commented May 10, 2024

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

@claudiacarpinteiro claudiacarpinteiro self-assigned this May 10, 2024
Copy link
Contributor

github-actions bot commented May 10, 2024

Overall readability score: 53.78 (馃敶 -0.06)

File Readability
service-account-integration.md 31.73 (馃煝 +0)
why-did-codacy-stop-commenting-on-pull-requests.md 40.88 (馃敶 -4.83)
using-a-dedicated-service-account.md 47.39 (-)
View detailed metrics

馃煝 - Shows an increase in readability
馃敶 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
service-account-integration.md 31.73 24.78 16.97 14.7 13.52 9.19
馃煝 +0 馃煝 +0 馃煝 +0 馃煝 +0 馃煝 +0 馃煝 +0
why-did-codacy-stop-commenting-on-pull-requests.md 40.88 22.55 13.3 15.8 13.81 7.56
馃敶 -4.83 馃敶 -10.49 馃敶 -0.51 馃敶 -1.2 馃敶 -0.7 馃煝 +0.16
using-a-dedicated-service-account.md 47.39 28.43 11.57 13.7 14.15 7.56
- - - - - -

Averages:

Readability FRE GF ARI CLI DCRS
Average 53.78 42.43 10.9 12.46 12.57 7.9
馃敶 -0.06 馃敶 -0.12 馃敶 -0.01 馃敶 -0.01 馃敶 -0.01 馃煝 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@github-actions github-actions bot temporarily deployed to Netlify May 10, 2024 14:15 Inactive
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"}
Copy link
Contributor Author

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?

Copy link
Contributor

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 馃槄

@github-actions github-actions bot temporarily deployed to Netlify May 23, 2024 11:38 Inactive
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.

None yet

2 participants