Make Jira app prerequisites more visible to readers
What does this MR do?
We've had some reviews in the Jira app that it doesn't work with self-managed instances https://marketplace.atlassian.com/apps/1221011/gitlab-com-for-jira-cloud?tab=reviews&hosting=cloud
Unfortunately we don't know the reason why for most of these reviews, but I'm wondering if users are missing some the prerequisites in our documentation. The way our docs are structured, it can easily be missed.
For Connect the GitLab for Jira Cloud app for self-managed instances:
- Removed the prerequisite "GitLab.com must serve as a proxy for the instance." as this is really a note. I've moved this into the main body.
- Moved the prerequisites under the main body of text
- Changed prerequisites to a header
- Changed the steps so users must check prerequisites are met before continuing.
For Install the GitLab for Jira Cloud app manually:
- Changed prerequisites to a header
- Changed the steps for both methods so users must check prerequisites are met before continuing.
Related issues
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.