Skip to content

Restructure Code Suggestions prerequisites for clarity

Amy Qualls requested to merge 405152-aqualls-improve-prereqs into master

What does this MR do?

Attempts to improve the prerequisites listed in https://docs.gitlab.com/ee/user/project/repository/code_suggestions/#use-code-suggestions because they're complex and customers stumbled.

I created this flowchart to help explain the complexity of what we're trying to convey:

flowchart TD
    C{Customer type}
    C -->|SaaS| D{Who to<br>enable for?}
    C -->|Self-managed| E{What GL version?}
    D -->|group| F["user/group/manage.html"]
    D --->|yourself| G["user/profile/preferences.html"]
    E -->|16.2 and <br>earlier| H["user/project/repository/code_suggestions/self_managed.html"]
    E --->|16.3 and <br>later| I["user/project/repository/code_suggestions/self_managed.html"]

I'm opting to keep the self-managed prerequisite simpler, because both sets of instructions (before/after 16.3) are on the same page.

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.

Merge request reports