docs: reorganize roles and permissions by Codacy role - #2732
Conversation
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>
Up to standards ✅🟢 Issues
|
|
Overall readability score: 53.74 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
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>
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>
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>
There was a problem hiding this comment.
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
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>
Summary
Operation | Allowedtables: Repository read/write/admin, Organization manager/admin).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.supported-languages-and-tools.md.Test plan
mkdocs build --strictpasses#permissions-for-github,#permissions-for-gitlab,#permissions-for-bitbucket,#change-analysis-configuration,#managing-the-organization-manager-role(linked fromaudit-logs-for-organizations.md,gitlab-integration.md,bitbucket-integration.md, a 2022 release note, andissues.md)vale docs/organizations/roles-and-permissions-for-organizations.md— 0 errors🤖 Generated with Claude Code