Skip to content
Snippets Groups Projects

Move Product Analytics docs and update requirements

Merged Lorena Ciutacu requested to merge 501261-docs-productanalytics into master
All threads resolved!

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 and Create 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

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 Lorena Ciutacu

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
    • Author Maintainer
      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 and Create 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
  • Lorena Ciutacu requested review from @lfarina8

    requested review from @lfarina8

  • Lindsy Farina approved this merge request

    approved this merge request

  • added 1 commit

    Compare with previous version

  • A deleted user added backend frontend labels

    added backend frontend labels

  • Lorena Ciutacu changed the description

    changed the description

  • Lorena Ciutacu requested review from @lyspin

    requested review from @lyspin

  • added 1 commit

    Compare with previous version

  • Lorena Ciutacu requested review from @drosse

    requested review from @drosse

  • changed milestone to %17.8

  • Daniele Rossetti approved this merge request

    approved this merge request

  • Bundle size analysis [beta]

    This compares changes in bundle size for entry points between the commits 2724163f and 620b46c6

    :sparkles: Special assets

    Entrypoint / 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 %

    :fearful: Significant Growth: 1

    Expand
    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 the bundle-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 :no_entry_sign: Danger

  • added 1 commit

    • 620b46c6 - Update removal date and issue links

    Compare with previous version

  • Lorena Ciutacu marked this merge request as ready

    marked this merge request as ready

  • Lysanne Pinto requested review from @lyspin

    requested review from @lyspin

  • Lysanne Pinto approved this merge request

    approved this merge request

  • Lorena Ciutacu requested review from @mwoolf

    requested review from @mwoolf

  • E2E Test Result Summary

    allure-report-publisher generated test report!

    e2e-test-on-gdk: :white_check_mark: test report for 620b46c6

    expand 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: :white_check_mark: test report for 620b46c6

    expand 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   | ✅     |
    +-------------+--------+--------+---------+-------+-------+--------+
  • Max Woolf approved this merge request

    approved this merge request

  • 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.

  • Lorena Ciutacu resolved all threads

    resolved all threads

  • Lorena Ciutacu mentioned in commit 2be7c181

    mentioned in commit 2be7c181

  • added workflowstaging label and removed workflowcanary label

  • mentioned in merge request gitlab-docs!5279 (merged)

  • Please register or sign in to reply
    Loading