Skip to content
Snippets Groups Projects

Use more consistent terminology in projects admin UI

What does this MR do?

I was having trouble reconciling what I was seeing in GitLab Rails UI and what I was seeing in the praefect tooling. Having to translate between the two places makes it harder to understand how it fits together.

So I've harmonized the terminology in the UI with what you'll find in the documentation (both for GitLab Rails and for gitaly project). I've also made the description of the relative path much more verbose to help folks understand how it relates to the virtual storage.

  • Before:

    Screenshot_2023-08-04_at_9.30.53_am

  • After:

    Screenshot_2023-08-10_at_3.23.19_pm

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 Evan Read

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
  • Evan Read
  • Allure report

    allure-report-publisher generated test report!

    e2e-test-on-gdk: :exclamation: test report for b50fca3b

    expand test summary
    +------------------------------------------------------------------+
    |                          suites summary                          |
    +-------------+--------+--------+---------+-------+-------+--------+
    |             | passed | failed | skipped | flaky | total | result |
    +-------------+--------+--------+---------+-------+-------+--------+
    | Create      | 46     | 0      | 1       | 2     | 47    | ❗     |
    | Plan        | 47     | 0      | 0       | 0     | 47    | ✅     |
    | Manage      | 12     | 0      | 1       | 3     | 13    | ❗     |
    | Data Stores | 20     | 0      | 0       | 0     | 20    | ✅     |
    | Govern      | 34     | 0      | 0       | 1     | 34    | ❗     |
    | Verify      | 8      | 0      | 0       | 0     | 8     | ✅     |
    +-------------+--------+--------+---------+-------+-------+--------+
    | Total       | 167    | 0      | 2       | 6     | 169   | ❗     |
    +-------------+--------+--------+---------+-------+-------+--------+

    e2e-package-and-test: :white_check_mark: test report for 374c01af

    expand test summary
    +-----------------------------------------------------------------------+
    |                            suites summary                             |
    +------------------+--------+--------+---------+-------+-------+--------+
    |                  | passed | failed | skipped | flaky | total | result |
    +------------------+--------+--------+---------+-------+-------+--------+
    | Create           | 559    | 0      | 70      | 0     | 629   | ✅     |
    | Systems          | 8      | 0      | 0       | 0     | 8     | ✅     |
    | Govern           | 4      | 0      | 0       | 0     | 4     | ✅     |
    | Plan             | 8      | 0      | 0       | 0     | 8     | ✅     |
    | Manage           | 2      | 0      | 0       | 0     | 2     | ✅     |
    | Package          | 0      | 0      | 2       | 0     | 2     | ➖     |
    | Data Stores      | 4      | 0      | 0       | 0     | 4     | ✅     |
    | Monitor          | 8      | 0      | 0       | 0     | 8     | ✅     |
    | Framework sanity | 0      | 0      | 2       | 0     | 2     | ➖     |
    +------------------+--------+--------+---------+-------+-------+--------+
    | Total            | 593    | 0      | 74      | 0     | 667   | ✅     |
    +------------------+--------+--------+---------+-------+-------+--------+
    Edited by Ghost User
  • Sincheol (David) Kim approved this merge request

    approved this merge request

  • :wave: @dskim_gitlab, thanks for approving this merge request.

    This is the first time the merge request is approved. To ensure full test coverage, a new pipeline will be started shortly.

    For more info, please refer to the following links:

  • Sincheol (David) Kim removed review request for @dskim_gitlab

    removed review request for @dskim_gitlab

  • :warning: @eread Some end-to-end (E2E) tests have been selected based on the stage label on this MR.

    Please start the trigger-omnibus-and-follow-up-e2e job in the qa stage and ensure the tests in follow-up-e2e:package-and-test-ee pipeline are passing before this MR is merged. (The E2E test pipeline is computationally intensive and we cannot afford running it automatically for all pushes/rebases. Therefore, this job must be triggered manually after significant changes at least once.)

    If you would like to run all E2E tests, please apply the pipeline:run-all-e2e label and trigger a new pipeline. This will run all tests in e2e:package-and-test pipeline.

    The E2E test jobs are allowed to fail due to flakiness. For the list of known failures please refer to the latest pipeline triage issue.

    Once done, please apply the :white_check_mark: emoji on this comment.

    For any questions or help in reviewing the E2E test results, please reach out on the internal #quality Slack channel.

  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Please register or sign in to reply
    Loading