Skip to content

Specify .tar.gz format for gzip-compressed tarballs #445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 24, 2025
Merged

Specify .tar.gz format for gzip-compressed tarballs #445

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94aaf17
Specify .tar.gz format for gzip-compressed tarballs
mjang Apr 23, 2025
f982481
Merge branch 'main' into mjang-patch-2
ADubhlaoich Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion templates/style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. | |
Expand Down Expand Up @@ -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. |
Expand Down
Loading