Move Product Analytics docs and update requirements
What does this MR do?
- Moves the PA page to /development.
- Removes PA and custom visualizations from data sources for dashboards.
- Removes PA references from troubleshooting.
- Marks the sections
Data explorer
andCreate a custom visualization
as deprecated. - Updates doc and UI links.
Related issues
Update docs to reflect changes to dashboards, O... (#501261 - closed)
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details under the H1 topic title. -
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.
Merge request reports
Activity
changed milestone to %17.7
assigned to @lciutacu
- A deleted user
added development guidelines docsimprovement labels
3 Warnings This merge request is quite big (782 lines changed), please consider splitting it into multiple merge requests. 983d21c5: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines. aad57f13: The commit subject must contain at least 3 words. For more information, take a look at our Commit message guidelines. 2 Messages This MR contains docs in the /doc/development directory, but any Maintainer (other than the author) can merge. You do not need tech writer review. This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
-
doc/administration/silent_mode/index.md
(Link to current live version) -
doc/operations/product_analytics/index.md
(Link to current live version) -
doc/tutorials/product_analytics_onboarding_website_project/index.md
(Link to current live version) -
doc/user/analytics/analytics_dashboards.md
(Link to current live version) -
doc/user/analytics/index.md
(Link to current live version) -
doc/user/product_analytics/index.md
(Link to current live version)
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
Reviewer roulette
Category Reviewer Maintainer backend @freinink
(UTC-7, 8 hours behind author)
@mhamda
(UTC+1, same timezone as author)
frontend @minahilnichols
(UTC-5, 6 hours behind author)
@anna_vovchenko
(UTC+2, 1 hour ahead of author)
Please refer to documentation page for guidance on how you can benefit from the Reviewer Roulette, or use the GitLab Review Workload Dashboard to find other available reviewers.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger-
- Resolved by Lorena Ciutacu
- Resolved by Lorena Ciutacu
@lfarina8 Here's a first take at moving and updating the Product Analytics docs:
- Moved the PA page to /development.
- Removed PA and custom visualizations from data sources for dashboards.
- Removed PA references from troubleshooting.
- Marked the sections
Data explorer
andCreate a custom visualization
as deprecated, since the features are available by default - though we don't plan on removing them? Should these go to /development too?
Do these changes make sense? How we should proceed? There are a few UI links that will need to be updated, but I'll do that after the new docs structure is confirmed.
Edited by Lorena Ciutacu
requested review from @lfarina8
added pipeline:mr-approved label
removed docs-only label
requested review from @lyspin
- Resolved by Lorena Ciutacu
- Resolved by Lorena Ciutacu
- Resolved by Lorena Ciutacu
- Resolved by Lorena Ciutacu
@drosse Can you please review these changes? I've updated the links to point to development docs for PA, but maybe we should even remove some links? I don't want to mess up the code by making more changes beyond docs
requested review from @drosse
changed milestone to %17.8
added missed:17.7 label
added pipelinetier-2 label
Bundle size analysis [beta]
This compares changes in bundle size for entry points between the commits 2724163f and 620b46c6
Special assetsEntrypoint / Name Size before Size after Diff Diff in percent average 4.42 MB 4.42 MB - 0.0 % mainChunk 3.28 MB 3.28 MB - 0.0 % Significant Growth: 1Expand
Entrypoint / Name Size before Size after Diff Diff in percent pages.projects.merge_requests.rapid_diffs 2.97 MB 3.06 MB +91.77 KB 3.0 %
Your MR has at least one entrypoint growing significantly (more > 1 KB or 2%). If you write new or extend existing features, this is expected and there is nothing to worry about.
Please consider pinging someone from the FE Foundations (
@leipert
,@markrian
,@pgascouvaillancourt
,@sdejonge
or@thutterer
) for review, if you are unsure about the size increase.Note: We do not have exact data for 2724163f. So we have used data from: 845390e1.
The target commit was too new, so we used the latest commit from master we have info on.
It might help to rerun thebundle-size-review
job
This might mean that you have a few false positives in this report. If something unrelated to your code changes is reported, you can check this comparison in order to see if they caused this change.Please look at the full report for more details
Read more about how this report works.
Generated by
Dangerrequested review from @lyspin
requested review from @mwoolf
E2E Test Result Summary
allure-report-publisher
generated test report!e2e-test-on-gdk:
test report for 620b46c6expand test summary
+------------------------------------------------------------------+ | suites summary | +-------------+--------+--------+---------+-------+-------+--------+ | | passed | failed | skipped | flaky | total | result | +-------------+--------+--------+---------+-------+-------+--------+ | Plan | 82 | 0 | 8 | 0 | 90 | ✅ | | Create | 135 | 0 | 20 | 0 | 155 | ✅ | | Govern | 80 | 0 | 12 | 0 | 92 | ✅ | | Monitor | 8 | 0 | 12 | 0 | 20 | ✅ | | Manage | 1 | 0 | 9 | 0 | 10 | ✅ | | Verify | 49 | 0 | 16 | 0 | 65 | ✅ | | Data Stores | 33 | 0 | 10 | 0 | 43 | ✅ | | Analytics | 2 | 0 | 0 | 0 | 2 | ✅ | | Package | 25 | 0 | 13 | 0 | 38 | ✅ | | Release | 5 | 0 | 1 | 0 | 6 | ✅ | | Secure | 4 | 0 | 3 | 0 | 7 | ✅ | | Fulfillment | 2 | 0 | 7 | 0 | 9 | ✅ | | Configure | 0 | 0 | 3 | 0 | 3 | ➖ | | Ai-powered | 0 | 0 | 2 | 0 | 2 | ➖ | | Growth | 0 | 0 | 2 | 0 | 2 | ➖ | | ModelOps | 0 | 0 | 1 | 0 | 1 | ➖ | +-------------+--------+--------+---------+-------+-------+--------+ | Total | 426 | 0 | 119 | 0 | 545 | ✅ | +-------------+--------+--------+---------+-------+-------+--------+
e2e-test-on-cng:
test report for 620b46c6expand test summary
+------------------------------------------------------------------+ | suites summary | +-------------+--------+--------+---------+-------+-------+--------+ | | passed | failed | skipped | flaky | total | result | +-------------+--------+--------+---------+-------+-------+--------+ | Govern | 84 | 0 | 10 | 0 | 94 | ✅ | | Manage | 1 | 0 | 9 | 0 | 10 | ✅ | | Create | 140 | 0 | 19 | 1 | 159 | ✅ | | Monitor | 8 | 0 | 12 | 0 | 20 | ✅ | | Verify | 50 | 0 | 15 | 0 | 65 | ✅ | | Plan | 86 | 0 | 8 | 0 | 94 | ✅ | | Configure | 0 | 0 | 3 | 0 | 3 | ➖ | | Data Stores | 33 | 0 | 10 | 0 | 43 | ✅ | | Growth | 0 | 0 | 2 | 0 | 2 | ➖ | | Package | 30 | 0 | 14 | 0 | 44 | ✅ | | Release | 5 | 0 | 1 | 0 | 6 | ✅ | | Analytics | 2 | 0 | 0 | 0 | 2 | ✅ | | Fulfillment | 2 | 0 | 7 | 0 | 9 | ✅ | | Secure | 2 | 0 | 5 | 0 | 7 | ✅ | | Ai-powered | 0 | 0 | 2 | 0 | 2 | ➖ | | ModelOps | 0 | 0 | 1 | 0 | 1 | ➖ | +-------------+--------+--------+---------+-------+-------+--------+ | Total | 443 | 0 | 118 | 1 | 561 | ✅ | +-------------+--------+--------+---------+-------+-------+--------+
added pipelinetier-3 pipeline:run-e2e-omnibus-once labels and removed pipelinetier-2 label
Before you set this MR to auto-merge
This merge request will progress on pipeline tiers until it reaches the last tier: pipelinetier-3. We will trigger a new pipeline for each transition to a higher tier.
Before you set this MR to auto-merge, please check the following:
- You are the last maintainer of this merge request
- The latest pipeline for this merge request is pipelinetier-3 (You can find which tier it is in the pipeline name)
- This pipeline is recent enough (created in the last 8 hours)
If all the criteria above apply, please set auto-merge for this merge request.
See pipeline tiers and merging a merge request for more details.
started a merge train
mentioned in commit 2be7c181
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
mentioned in merge request gitlab-docs!5279 (merged)
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label