Skip to content

Add warning about undocumented authentication methods

Context

Because of the way code has been reused to implement authentication for the Package Registry, there are a number of undocumented authentication methods for the various package formats. Just because these exist does not mean that customers should use them, much less depend on them being supported. We should add a warning to the documentation that these undocumented authentication methods should not be used and may be removed in the future.

What does this MR do?

For each of the Package Registry package formats, add a warning to the documentation that undocumented authentication methods should not be used and may be removed in the future.

For package format documentations that have an Authentication section, I added the warning inside that section, right after the list of supported authentication methods.

For documentations that do not have an Authentication section, I added the warning at the topmost section.

Related issues

#326670 (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 Radamanthus Batnag

Merge request reports

Loading