Skip to content

Draft: Clarify intermediate cert file options

Keelan Lang requested to merge docs-klang-intermediatecertfileoptions into main

What does this MR do?

While working with a customer, I found that this section of our self-signed cert doc was a bit misleading, particularly around placing all certs in a chain in one file.

In reality, while some images may allow users to place all certs in one file, others require each to be in a separate file, and still others may allow either option.

In order to elaborate on this, I have moved the confusing "note" to its own section, and added more context. My goal is to clarify that there are multiple ways to approach this, depending on use case. My goal is to make the document more clear, while accounting for more use cases. Having the section written as it is now would have deflected at least one ticket, and ought to help deflect more in the future, which in my opinion is worth the change!

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 above reviews. Maintainer's review can occur before or after a technical writer review.

Merge request reports