Skip to content

Split visibility settings into separates tables in API doc

Marcel Amirault requested to merge docs-builds-access-level-api into master
  • Please check this box if this contribution uses AI-generated content as outlined in the GitLab DCO & CLA.

What does this MR do?

We had some customer questions about how exactly the *_access_level project settings (in the API) actually relate to the relevant features, it's not clear what disabled, private or enabled mean exactly. I got an engineer to check the code and they figured out these are the API settings for the Visibility, project features, permissions section of project settings, where:

  • disabled: Disables the feature.
  • private: Enables and sets the feature to Only project members.
  • enabled: Enables and sets the feature to Everyone with access.

We should make this clearer in the doc. Instead of repeating these details in every single setting, I've split them out into their own tables, and mentioned the details just once at the top, and using the details column to link to the relevant features.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Marcel Amirault

Merge request reports