Skip to content

Restore correct wording in reference to external product

David Nelson requested to merge davidnelson-har into master

What does this MR do?

Several months ago there was a large MR which fixed a lot of spelling mistakes in the docs, apparently based on an automated tool. This MR included separating "HTTPArchive" into "HTTP Archive". However, the documentation in question is referring to the UI of an external product, where "HTTPArchive" is what the user sees (https://docs.telerik.com/fiddler/save-and-load-traffic/tasks/importexportdefault). We want to match the wording from the external product, regardless of whether it is correct or not.

I don't know what automated tool generated the original warning, or if there is a way to suppress it so that it doesn't get "fixed" again.

image

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.

Merge request reports

Loading