Skip to content

docs: reorganize roles and permissions by Codacy role - #2732

Merged
claudiacodacy merged 6 commits into
masterfrom
claude/wide-table-reorganization-4a7793
Aug 12, 2026
Merged

docs: reorganize roles and permissions by Codacy role#2732
claudiacodacy merged 6 commits into
masterfrom
claude/wide-table-reorganization-4a7793

Conversation

@claudiacodacy

Copy link
Copy Markdown
Contributor

Summary

  • Replaces the three wide GitHub/GitLab/Bitbucket permission grids on Roles and permissions for organizations (up to 10 columns each) with a short per-provider role-mapping list plus one shared "Permissions by Codacy role" section (5 narrow Operation | Allowed tables: Repository read/write/admin, Organization manager/admin).
  • The Yes/No/Configurable value for a given operation was identical across all three provider tables for a given Codacy role — verified row by row against the original data — so this states each fact once instead of three times, in addition to removing the horizontal scroll.
  • Surfaces one previously-implicit nuance explicitly: Bitbucket has no role that maps to Repository write or Repository admin (its Admin role jumps straight to Organization admin).
  • Removed the tr:nth-child(1) brand-highlight CSS rule at the bottom of the page — it only ever targeted the "Codacy role" legend row in the old wide tables, which no longer exists in this structure.
  • Follow-up to docs: reorganize supported languages and tools by scan type #2731, which did the analogous wide-table reorg for supported-languages-and-tools.md.

Test plan

  • mkdocs build --strict passes
  • Confirmed in the built HTML that all pre-existing inbound anchors still resolve: #permissions-for-github, #permissions-for-gitlab, #permissions-for-bitbucket, #change-analysis-configuration, #managing-the-organization-manager-role (linked from audit-logs-for-organizations.md, gitlab-integration.md, bitbucket-integration.md, a 2022 release note, and issues.md)
  • vale docs/organizations/roles-and-permissions-for-organizations.md — 0 errors
  • Cross-checked every operation's Yes/No/Configurable value against the original per-provider tables before merging them into the shared Codacy-role tables

🤖 Generated with Claude Code

Splits the three wide GitHub/GitLab/Bitbucket permission grids (up to
10 columns each) into short per-provider role-mapping lists plus one
shared set of narrow Operation|Allowed tables per Codacy role. The
same permission values were being repeated identically across all
three provider tables; this states each fact once instead of three
times and removes the horizontal scroll. Follow-up to #2731, which did
the analogous reorg for supported-languages-and-tools.md.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@codacy-production

Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Overall readability score: 53.74 (🟢 +0)

File Readability
roles-and-permissions-for-organizations.md 61.52 (🔴 -0.39)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
roles-and-permissions-for-organizations.md 61.52 31.89 8.53 11.6 13.04 6.4
  🔴 -0.39 🔴 -6.43 🟢 +0.31 🟢 +0.6 🔴 -0.11 🔴 -0.18

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.74 42.77 10.97 12.4 12.31 8.03
  🟢 +0 🔴 -0.02 🟢 +0 🟢 +0 🟢 +0 🟢 +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 August 12, 2026 13:18 Inactive
The five separate Operation|Allowed tables made it hard to compare
roles side by side, which is the more common use case (an admin
deciding what role to assign) than looking up a single role. Replaces
them with one table (Operation rows x 5 Codacy-role columns) so all
roles are visible at once, still narrower than the original per-provider
tables. Anchors for each role are preserved via id attributes on the
table header cells.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify August 12, 2026 13:38 Inactive
Bulleted lists forced a comma-separated set of provider roles into a
bolded "term," which is an awkward fit for a plain role-to-role
mapping. A two-column table (Git provider role | Codacy role) is the
more direct container for that comparison.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify August 12, 2026 13:45 Inactive
The footnote on "Add and remove repository" only existed on the
original GitHub table; GitLab and Bitbucket's identical Yes had no
such caveat. Merging the three provider tables into one shared
Repository admin column left the footnote attached to a value
GitLab/Bitbucket readers also see, so make the scope explicit rather
than let it read as a cross-provider requirement.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify August 12, 2026 13:52 Inactive
@claudiacodacy
claudiacodacy marked this pull request as ready for review August 12, 2026 13:53
@claudiacodacy
claudiacodacy requested a review from a team as a code owner August 12, 2026 13:53

@codacy-production codacy-production Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

The documentation reorganization successfully consolidates provider-specific permission tables into a single shared table, improving readability and eliminating horizontal scrolling issues. The migration preserves existing navigation anchors and correctly identifies role mapping limitations for Bitbucket. While the PR is up to standards, minor CSS inconsistencies in the table header styling and ambiguous footnote numbering should be corrected to ensure visual consistency and clarity for readers.

About this PR

  • The document reuses footnote index '1' across four different sections (GitHub, GitLab, Bitbucket, and general Permissions). This pattern should be replaced with unique sequential indices (1-7) or unique markers for each table to ensure readers can clearly map references to their definitions.

Test suggestions

  • Execute 'mkdocs build --strict' to ensure no broken internal links or documentation syntax errors.
  • Verify that all pre-existing anchors (e.g., #managing-the-organization-manager-role) resolve to correct sections in the generated HTML.
  • Cross-reference the new shared table values against the previous version to ensure no permission regressions occurred during the merge.
  • Perform linting with Vale to ensure the new content complies with documentation style and grammar standards.

TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback

Comment thread docs/organizations/roles-and-permissions-for-organizations.md
Comment thread docs/organizations/roles-and-permissions-for-organizations.md Outdated
The comment said borders were "disabled" for horizontal lines when the
rule actually adds them via border-top. th was also missing from the
selector, so header cells lacked the vertical dividers body cells get.

Addresses Codacy AI review feedback on #2732.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@github-actions
github-actions Bot temporarily deployed to Netlify August 12, 2026 14:46 Inactive
@claudiacodacy
claudiacodacy enabled auto-merge (squash) August 12, 2026 15:08
@github-actions
github-actions Bot temporarily deployed to Netlify August 12, 2026 15:09 Inactive
@claudiacodacy
claudiacodacy merged commit 49c43b5 into master Aug 12, 2026
5 checks passed
@claudiacodacy
claudiacodacy deleted the claude/wide-table-reorganization-4a7793 branch August 12, 2026 15:09
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