Skip to content
Snippets Groups Projects

Updated documentation generator for custom roles

4 unresolved threads
  • Please check this box if this contribution uses AI-generated content (including content generated by GitLab Duo features) as outlined in the GitLab DCO & CLA

What does this MR do and why?

  • Updated the docs generator for custom roles to a new format (as described in #482752 (closed))
  • Compiled custom roles docs
  • Removed 2 unnecessary methods in docs generator for custom roles

Screenshots or screen recordings

image image

How to set up and validate locally

Related to #482752 (closed)

Edited by 🤖 GitLab Bot 🤖

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Florian Lang added 261 commits

    added 261 commits

    • 8ee0578a...f6066607 - 259 commits from branch gitlab-org:master
    • 1fdc0282 - Added `title` field to new ability admin_protected_branch
    • de94dc21 - Merge remote-tracking branch 'origin/482750-add-title-to-new-custom-ability'...

    Compare with previous version

  • Florian Lang reset approvals from @jarka by pushing to the branch

    reset approvals from @jarka by pushing to the branch

  • Florian Lang added 1 commit

    added 1 commit

    Compare with previous version

  • Florian Lang mentioned in merge request !167405 (merged)

    mentioned in merge request !167405 (merged)

  • @hmehra, this Community contribution was recently assigned to you for review.

    • Do you still have capacity to review this? We are mindful of your time, so if you are not able to take this on, please re-assign to one or more other reviewers.
    • Add the workflowin dev label if the merge request needs action from the author.

    This message was generated automatically. You're welcome to improve it.

  • added workflowin dev label and removed workflowready for review label

  • Hinam Mehra removed review request for @hmehra

    removed review request for @hmehra

  • @Florian_Lang, it seems we're waiting on an action from you for approximately two weeks.

    This message was generated automatically. You're welcome to improve it.

  • Author Contributor
  • requested review from @a_akgun

  • Alper Akgun requested review from @hmehra

    requested review from @hmehra

  • Alper Akgun removed review request for @a_akgun

    removed review request for @a_akgun

  • added backend label

  • Hinam Mehra changed milestone to %17.6

    changed milestone to %17.6

  • 9 9 <% "#{feature_category.humanize}" %>
    10 10 <% end %>
    11 11 <% end %>
    12 <% def enabled_link(ability) %>
    • suggestion: we do need support for feature-flags for when we introduce newer abilities. They can go in the Introduced in column, such as:

      Introduced in GitLab 16.1 with a flag named x. Disabled by default.

    • Author Contributor

      Do I understand it right that if the feature flag is enabled it should only show die Gitlab version it was introduced in and if the feature flag hasn't been enable the message above should show up?

    • Author Contributor

      @hmehra i forgot the mention you here

    • @Florian_Lang if the custom ability is behind a feature flag, such as custom_ability_read_admin_dashboard then it should say the milestone it was introduced in. If the feature flag is default_enabled: false then Disabled by default should be added.

    • Please register or sign in to reply
  • 96 |:-----|:------------|:------------------|:---------|:--------------|:---------|
    97 | [`manage_group_access_tokens`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/140115) | | Create, read, update, and delete group access tokens. When creating a token, users with this custom permission must select a role for that token that has the same or fewer permissions as the default role used as the base for the custom role. | GitLab [16.8](https://gitlab.com/gitlab-org/gitlab/-/issues/428353) | | |
    98 | [`manage_project_access_tokens`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132342) | | Create, read, update, and delete project access tokens. When creating a token, users with this custom permission must select a role for that token that has the same or fewer permissions as the default role used as the base for the custom role. | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/421778) | `manage_project_access_tokens` | GitLab [16.8](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/141294) |
    95 | Permission | Description | API Attribute | Scope | Introduced in |
    96 |:-----------|:------------|:--------------|:------|:--------------|
    97 | Manage group access tokens | Create, read, update, and delete group access tokens. When creating a token, users with this custom permission must select a role for that token that has the same or fewer permissions as the default role used as the base for the custom role. | [`manage_group_access_tokens`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/140115) | Group | GitLab [16.8](https://gitlab.com/gitlab-org/gitlab/-/issues/428353) |
    98 | Manage project access tokens | Create, read, update, and delete project access tokens. When creating a token, users with this custom permission must select a role for that token that has the same or fewer permissions as the default role used as the base for the custom role. | [`manage_project_access_tokens`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/132342) | Project | GitLab [16.5](https://gitlab.com/gitlab-org/gitlab/-/issues/421778) |
    99 99
    100 100 ## Team planning
    101 101
    102 | Name | Required permission | Description | Introduced in | Feature flag | Enabled in |
    103 |:-----|:------------|:------------------|:---------|:--------------|:---------|
    104 | [`read_crm_contact`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/154017) | | Read CRM contact. | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/443268) | | |
    102 | Permission | Description | API Attribute | Scope | Introduced in |
    103 |:-----------|:------------|:--------------|:------|:--------------|
    104 | View CRM contact | Read CRM contact. | [`read_crm_contact`](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/154017) | Group | GitLab [17.1](https://gitlab.com/gitlab-org/gitlab/-/issues/443268) |
  • Hinam Mehra removed review request for @hmehra

    removed review request for @hmehra

  • Hi @hmehra 👋

    We noticed this MR is marked as workflowready for review but no reviewer is assigned. workflowin dev has automatically been applied to this MR based on the likelihood the review is finished. If additional reviews are still required, please assign a reviewer and reapply workflowready for review.

    @Florian_Lang you may also request a review by commenting @gitlab-bot ready. You can also assign reviewers directly using @gitlab-bot ready @user1 @user2 if you know the relevant reviewer(s), such as those who were involved in a related issue.

    This message was generated automatically. You're welcome to improve it.

  • Hinam Mehra requested review from @hmehra

    requested review from @hmehra

  • Hinam Mehra removed review request for @hmehra

    removed review request for @hmehra

  • @Florian_Lang, it seems we're waiting on an action from you for approximately two weeks.

    This message was generated automatically. You're welcome to improve it.

  • added idle label

  • Jay mentioned in issue #482752 (closed)

    mentioned in issue #482752 (closed)

  • removed idle label

  • Florian Lang added 15395 commits

    added 15395 commits

    • 879e7a16...e6e7ab63 - 15394 commits from branch gitlab-org:master
    • b60e88fe - Merge branch 'master' into 482752-updated-custom-roles-docs-generator

    Compare with previous version

  • closed

  • @Florian_Lang, how was your code review experience with this merge request? Please tell us how we can continue to iterate and improve:

    1. React with a 👍 or a 👎 on this comment to describe your experience.
    2. Create a new comment starting with @gitlab-bot feedback below, and leave any additional feedback you have for us in the comment.

    As a benefit of being a GitLab Community Contributor, you have access to GitLab Duo, our AI-powered features. With Code Suggestions, Chat, Root Cause Analysis and more AI-powered features, GitLab Duo helps to boost your efficiency and effectiveness by reducing the time required to write and understand code and pipelines. Visit the GitLab Duo documentation to learn more about the benefits.

    Subscribe to the GitLab Community Newsletter for contributor-focused content and opportunities to level up.

    Thanks for your help! ❤️

    This message was generated automatically. Improve it or delete it.

  • Please register or sign in to reply
    Loading