Adds a test for variants of the word 'dialog' (!126330) · Merge requests · GitLab.org / GitLab

Amy Qualls requested to merge aqualls-dialog-test into master Jul 13, 2023

What does this MR do?

Here's one possible way to test for phrases that we should use dialog for: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#dialog A convincing case could be made that these should be lumped into SubstitutionWarning.yml; I separated them out so I could:

provide a more focused help link
get an accurate count of how many results are returned

Oddity in results

I've ordered the phrases from most specific (like modal window) to least specific (modal). I'm getting slightly different messaging returned depending on whether I'm in the VS Code UI or in the CLI.

The CLI results for administration/monitoring/performance/performance_bar.md just say modal:

 administration/monitoring/performance/performance_bar.md
 25:5   error  Use 'dialog' instead of 'modal' when possible.  gitlab.Dialog
 38:62  error  Use 'dialog' instead of 'modal' when possible.  gitlab.Dialog
 41:37  error  Use 'dialog' instead of 'modal' when possible.  gitlab.Dialog
 43:36  error  Use 'dialog' instead of 'modal' when possible.  gitlab.Dialog
 45:44  error  Use 'dialog' instead of 'modal' when possible.  gitlab.Dialog
 47:66  error  Use 'dialog' instead of 'modal' when possible.  gitlab.Dialog
 51:23  error  Use 'dialog' instead of 'modal' when possible.  gitlab.Dialog

but in VS Code, the full phrase modal window is flagged in administration/monitoring/performance/performance_bar.md. Not sure why:

Expand to see screenshot

New warnings

Expand to see the 76 results

development/product_qualified_lead_guide/index.md 48:232 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 90:314 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

development/database/database_lab.md 152:9 error Use 'dialog' instead of 'pop-up' when possible. gitlab.Dialog

development/spam_protection_and_captcha/web_ui.md 44:95 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 48:1 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

development/spam_protection_and_captcha/exploratory_testing.md 72:72 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

development/testing_guide/end_to_end/style_guide.md 73:7 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

development/cached_queries.md 90:70 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 92:72 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 94:34 error Use 'dialog' instead of 'Modal' when possible. gitlab.Dialog

development/fe_guide/frontend_faq.md 53:2 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

development/fe_guide/accessibility.md 556:61 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

ci/environments/deployment_approvals.md 146:14 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

ci/testing/unit_test_reports.md 64:32 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

ci/review_apps/index.md 86:25 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

integration/vault.md 121:50 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/group/access_and_permissions.md 297:39 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/group/index.md 270:39 error Use 'confirmation dialog' instead of 'confirmation box' when possible. gitlab.Dialog

user/group/manage.md 112:102 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 113:5 error Use 'dialog' instead of 'Modal' when possible. gitlab.Dialog

user/group/epics/manage_epics.md 149:25 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/application_security/coverage_fuzzing/index.md 345:37 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/application_security/policies/index.md 68:5 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/application_security/dast/browser_based_troubleshooting.md 64:20 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/application_security/dast/authentication.md 198:84 error Use 'dialog' instead of 'pop-up' when possible. gitlab.Dialog 198:92 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/application_security/dast/proxy-based.md 167:40 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/application_security/api_fuzzing/index.md 109:6 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/project/releases/index.md 273:14 error Use 'dialog' instead of 'dialog box' when possible. gitlab.Dialog 309:59 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 311:40 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 313:20 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/project/repository/branches/index.md 270:11 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/project/time_tracking.md 84:95 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/project/web_ide/index.md 133:11 error Use 'dialog' instead of 'pop-up' when possible. gitlab.Dialog

user/project/requirements/index.md 306:19 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/project/merge_requests/allow_collaboration.md 65:11 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/project/merge_requests/status_checks.md 142:30 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 144:24 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/project/merge_requests/cherry_pick_changes.md 61:11 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 76:88 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 77:11 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 91:88 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 92:11 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 106:88 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 107:11 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 120:88 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/project/merge_requests/reviews/index.md 127:80 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 128:10 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/project/members/share_project_with_groups.md 49:102 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 51:5 error Use 'dialog' instead of 'Modal' when possible. gitlab.Dialog

user/project/members/index.md 108:102 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 109:5 error Use 'dialog' instead of 'Modal' when possible. gitlab.Dialog 159:102 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 160:5 error Use 'dialog' instead of 'Modal' when possible. gitlab.Dialog

user/project/issues/csv_export.md 48:14 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/tasks.md 44:51 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 110:30 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

user/profile/comment_templates.md 67:87 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

operations/incident_management/slack.md 52:13 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

operations/incident_management/incidents.md 111:13 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

operations/incident_management/oncall_schedules.md 119:14 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

operations/incident_management/alerts.md 93:13 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

architecture/blueprints/work_items/index.md 105:107 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

api/openapi/openapi_interactive.md 42:1 error Use 'dialog' instead of 'dialog box' when possible. gitlab.Dialog

tutorials/manage_user/index.md 216:29 error Use 'confirmation dialog' instead of 'confirmation box' when possible. gitlab.Dialog

administration/monitoring/performance/performance_bar.md 25:5 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 38:62 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 41:37 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 43:36 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 45:44 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 47:66 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 51:23 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

administration/audit_event_streaming/index.md 233:55 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 266:55 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog 295:55 error Use 'dialog' instead of 'modal' when possible. gitlab.Dialog

Related issues

Related to Update references to dialogs (!125535 - merged)
Related to Add guidance on dialog (!126135 - merged)

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 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 Jul 13, 2023 by Amy Qualls

Adds a test for variants of the word 'dialog'