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

feat: Add organization configuration to quickstart guided path DOCS-708 #2155

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

Conversation

claudiacarpinteiro
Copy link
Contributor

@claudiacarpinteiro claudiacarpinteiro commented Jun 27, 2024

Adds organization configuration step to the Codacy quickstart guided path.

👀 Live preview

🚧 To do

  • Update content
  • Request validation
  • Apply feedback
  • Remove don't merge label before merging

@claudiacarpinteiro claudiacarpinteiro self-assigned this Jun 27, 2024
@claudiacarpinteiro claudiacarpinteiro added the don't merge Don't merge this pull request yet label Jun 27, 2024
Copy link
Contributor

github-actions bot commented Jun 27, 2024

Overall readability score: 53.92 (🔴 -0.05)

File Readability
nav-multistep-quickstart.md 100 (🟢 +0)
codacy-quickstart.md 45.27 (🔴 -5.37)
configuring-your-organization.md 43.77 (-)
configuring-your-repository.md 35.47 (🟢 +4.81)
integrating-codacy-with-intellij-ides.md 66.76 (🟢 +0.43)
integrating-codacy-with-visual-studio-code.md 67.93 (🟢 +0.08)
integrating-codacy-with-your-git-workflow.md 47.4 (🟢 +0)
cloud-2023-06.md 56.39 (🟢 +0)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
nav-multistep-quickstart.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
codacy-quickstart.md 45.27 38.21 12.34 13.3 14.09 8.52
  🔴 -5.37 🟢 +0 🔴 -0.65 🔴 -0.8 🔴 -0.87 🔴 -0.58
configuring-your-organization.md 43.77 27.72 12.21 14.3 14.67 7.81
  - - - - - -
configuring-your-repository.md 35.47 23.36 13.91 16.1 14.57 8.49
  🟢 +4.81 🔴 -3.49 🟢 +2.15 🟢 +1.7 🔴 -0.93 🟢 +0.17
integrating-codacy-with-intellij-ides.md 66.76 52.6 10.48 10.6 9.86 6.64
  🟢 +0.43 🟢 +0.11 🟢 +0.09 🟢 +0.1 🟢 +0.06 🟢 +0.01
integrating-codacy-with-visual-studio-code.md 67.93 52.6 9.99 10.8 10.04 6.37
  🟢 +0.08 🟢 +0 🟢 +0.03 🟢 +0 🟢 +0 🟢 +0.01
integrating-codacy-with-your-git-workflow.md 47.4 42 12.76 14.4 13.29 7.68
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
cloud-2023-06.md 56.39 61.12 10.79 11.4 12.73 8.52
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.92 42.79 10.8 12.48 12.59 7.91
  🔴 -0.05 🔴 -0.09 🟢 +0 🟢 +0 🔴 -0.02 🟢 +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 June 27, 2024 16:43 Inactive
@github-actions github-actions bot temporarily deployed to Netlify June 27, 2024 16:47 Inactive
@github-actions github-actions bot temporarily deployed to Netlify July 1, 2024 14:45 Inactive
@github-actions github-actions bot temporarily deployed to Netlify July 1, 2024 17:40 Inactive
@github-actions github-actions bot temporarily deployed to Netlify July 5, 2024 13:45 Inactive
@github-actions github-actions bot temporarily deployed to Netlify July 5, 2024 14:34 Inactive
Copy link
Contributor

codacy-production bot commented Jul 8, 2024

summary list with impacted files

summary list with impacted lines

summary list with new features

summary list with bug fixes

summary list with improvements

summary list with deprecated features

summary list with security enhancements

summary list with performance enhancements

summary list with documentation updates

summary list with other changes


feat: Add organization configuration to quickstart guided path

Adding organization configuration to Codacy

This pull request adds the configuration of an organization to the Codacy quickstart guided path.

Summary

  • Added a new step to the quickstart guided path for configuring an organization
  • Updated the documentation to reflect the new step

Impacted files

  • docs/assets/includes/nav-multistep-quickstart.md
  • docs/getting-started/codacy-quickstart.md
  • docs/getting-started/configuring-your-organization.md

Impacted lines

  • Added a new step to the quickstart guided path
  • Updated the documentation to reflect the new step

New features

  • None

Bug fixes

  • None

Improvements

  • Improved the user experience of the quickstart guided path

Deprecated features

  • None

Security enhancements

  • None

Performance enhancements

  • None

Documentation updates

  • Updated the documentation to reflect the new step in the quickstart guided path

Other changes

  • None

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 8, 2024 16:08 Inactive
@github-actions github-actions bot temporarily deployed to Netlify August 12, 2024 14:35 Inactive
@nicklem nicklem removed their assignment Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
don't merge Don't merge this pull request yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants