Skip to content

Docs: Improve documentation for external / load balancer SSL termination

DarwinJS requested to merge DarwinJS-master-patch-82402 into master

What does this MR do?

Customers and internal technical specialists are having difficulty navigating this document because it only uses the terminology "Proxied SSL" and does not include other common terms for the same thing.

Update the documentation to add cloud oriented terminology "External SSL termination" and "Load balancer SSL termination" (at the heading level).

Also updated the description to give troubleshooting clues - that without the disable configuration, the instance automatically attempts to configured local SSL termination and that once these configs are flipped, it stops doing that.

Added a note under Enabling HTTPS to point to the renamed section since this type of SSL termination is very common.

Related issues

Author's checklist (required)

Do not add the ~"feature", frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by DarwinJS

Merge request reports

Loading