Skip to content

Fix formatting of HTTPS implementation description - #2235

Open
mjang wants to merge 1 commit into
mainfrom
mjang-patch-2
Open

Fix formatting of HTTPS implementation description#2235
mjang wants to merge 1 commit into
mainfrom
mjang-patch-2

Conversation

@mjang

@mjang mjang commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Proposed changes

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@mjang
mjang requested a review from TimKozlowski August 31, 2026 17:17
@mjang mjang self-assigned this Aug 31, 2026
@mjang
mjang requested a review from a team as a code owner August 31, 2026 17:17
@github-actions github-actions Bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Aug 31, 2026
@github-actions

Copy link
Copy Markdown

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/2235/

@promptless promptless Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the cleanup, @mjang! I ran this through the F5 Technical Writing Style Guide on Promptless's behalf, the same review the team runs before a writer picks a PR up from the gardening rotation.

Result: Looks good. This change removes trailing whitespace after "Implement HTTPS with Let's Encrypt to secure client-server communication." in the content/ngf/_index.md "Secure traffic using Let's Encrypt" card. The visible prose is unchanged, and dropping the trailing space also brings the line into line with markdownlint MD009.

Style check on the affected content: No findings. The sentence is short (9 words, well under the task-sentence limit), active voice, present tense, and imperative. Product and proper-noun casing (HTTPS, Let's Encrypt) is correct, no NGINX product name is abbreviated, and there are no terminology, punctuation, or accessibility issues in the changed content.

Reading level: Not a factor here. The single affected sentence is well within the Grade 8–9 target; nothing drives complexity up.

Technical accuracy: No technical claims changed, so nothing needs subject-matter-expert verification.

Categories checked in full: voice-and-tone, grammar (per the always-read rule), plus terminology, punctuation, formatting, and procedures against the changed content. Skipped: accessibility, media, error-messages, and security — the change adds no image, error string, or sensitive value and touches no such existing content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant