diff --git a/templates/style-guide.md b/templates/style-guide.md index 410e4e937..d97e06a98 100644 --- a/templates/style-guide.md +++ b/templates/style-guide.md @@ -297,7 +297,7 @@ The table provides guidelines about the terms you should and should not use for | SSLi/SSL Intercept | For the SSL Intercept iRule. Spell out. Do not abbreviate except to match UI label. | | | Sync-Failover (and Sync-Only) | Title capitalize and hyphenate to Sync-Failover unless referencing the option in tmsh; then lowercase and hyphenate as sync-failover. These guidelines apply to Sync-Only as well. | | | tap | Describes action of touching the hardware touchscreens in hardware documentation. Do not use in software documentation; use "select" instead. | | -| tarball | tarball is defined as "files distributed as a tar archive"; a computer file format that can combine multiple files into a single, typically compressed, file. | | +| tarball | tarball is defined as "files distributed as a tar archive"; a computer file format that can combine multiple files into a single, typically compressed, file. For the standard `gzip` compression algorithm, use the `tar.gz` extension for such files | | | TCP flag names | All caps. SYN, ACK, PSH, URG, FIN, etc. (Industry standard) | | | tense | Strive to use the simple present tense rather than the past or future, unless necessary for clarity. Do not: The system will receive. Do: The system receives. Do not: The feature was introduced in NGINX Instance Manger 2.16. Do: The feature is introduced in NGINX Instance Manager 2.16. (Remember that for some users older versions are used in the present.) | | | text box | Use box. | | @@ -503,6 +503,7 @@ this style guide over time. This guide uses the Major.Minor.Patch | Edition | Date | Lead Author(s) | Comments | |---------|---------------|----------------|-------------------------------------------------------| +| 1.11 | April 23, 2025 | Mike Jang | Specify use of .tar.gz for tarballs. | | 1.10 | February 19, 2025 | Mike Jang | Clarify use of nested includes. | | 1.9 | December 10, 2024 | Mike Jang | Specify the use of "license" when writing about the JWT token associated with licensed versions of NGINX. | | 1.8 | December 4, 2024 | Jon Torre | Clarify that heading text must not contain a link to other pages. |