Skip to content

Clarify the Jira Server credential steps

Anton Smith requested to merge docs/clarify-jira-server-credential-steps into master

What does this MR do?

Following the discussion in !118655 (comment 1378222347), this MR does the following:

  1. Clarifies that an existing Jira Server user can be used to configure the Jira integration in GitLab
  2. Reiterates in the top section that once a Jira Server user has been selected that the Jira integration needs to be configured (and links off to that)
  3. Links to the Atlassian docs on how to create a user. I put this in so its clear to readers that they must click Create user rather than Invite user.
  4. Links the permission section back to the groups section
  5. Changes the Email address and Username requirements to match up with my observations in !118655 (comment 1377531476)
    • The Email address did not need to be valid for me. I've changed this to recommend to use a valid email address instead.
    • The Username was not based on the email address and this was not imposed on me by Jira. Since our docs is walking the reader through how to setup a Jira user with the username gitlab, let's make that explicit here.
    • The Password field can be set and applied at the same time a Jira user is created. The docs currently imply you need to come back after the user is created to set the password which is not true.

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 Anton Smith

Merge request reports

Loading