Skip to content

Clarify npm package registry behaviour

Simon Street requested to merge docs-ss-npm-registry-202310 into master

What does this MR do?

Clarify how the current npm forwarding code operates.

Forwarding suggests that GitLab handles this transparently, I would think that redirect is better terminology here but that would have knock on changes else where in the UI for the language used there.

Adding a note here seems like a quick/boring solution to avoid confusion.

A customer has raised the current documentation/behavior as a defect on ZD 458648 (internal):

Despite the fact that the product documentation and the configuration screen clearly state that requests are forwarded, the product does not function in this way. We consider it as a defect.

Related issues

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