You need to sign in or sign up before continuing.
CTRT for Insights for projects page part 1
What does this MR do?
CTRT updates for the first three sections in Insights for projects:
- Renamed headings to remove 'your' so that it resembles what a user would search for.
- Refactored text to make it more concise and to remove duplicated text.
- Removed unnecessary screenshot.
- Added more configuration instructions for the insights configuration file.
The sections that describe the configuration file parameters will be addressed in a separate MR: !98915 (merged)
Before:
https://docs.gitlab.com/ee/user/project/insights/#insights
After:
http://main-ee-98905.35.193.151.162.nip.io/ee/user/project/insights/
Related issues
technical-writing#579 (closed)
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 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.
Edited by Fiona Neill