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

clean: Create a dedicated section for the service account procedure DOCS-680 #2103

Closed
wants to merge 4 commits into 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.99 (🔴 -0.06)

File Readability
service-account-integration.md 31.73 (🟢 +0)
why-did-codacy-stop-commenting-on-pull-requests.md 41.07 (🔴 -4.86)
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 41.07 22.55 13.19 15.8 13.81 7.56
  🔴 -4.86 🔴 -10.49 🔴 -0.53 🔴 -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.99 42.94 10.81 12.48 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
Copy link
Contributor


Create a dedicated section for the service account procedure

Add documentation on using a dedicated service account

  • Create a new page on the documentation website
  • Add a new section to the existing service-account-integration.md file
  • Update the faq/troubleshooting/why-did-codacy-stop-commenting-on-pull-requests.md file
  • Add a new page on the repositories-configure/integrations/ directory

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).

@github-actions github-actions bot temporarily deployed to Netlify July 12, 2024 09:27 Inactive
@nicklem
Copy link
Contributor

nicklem commented Aug 5, 2024

Closing this one for now.

@nicklem nicklem closed this Aug 5, 2024
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.

2 participants