Skip to content

docs: update tarball extension from .tgz to tar.gz in markdown files #480

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update tarball extension from .tgz to tar.gz in markdown files #480

wants to merge 1 commit into from
+95 −95

Conversation

Dindihub
Copy link

@Dindihub Dindihub commented Apr 30, 2025 •
edited by ADubhlaoich
Loading

Proposed changes

Problem: I updated the Tarball extension from .tgz to tar.gz in markdown files in the content folder

Solution: Searched for .tgz mentions in markdown and replaced with tar.gz as indicated in the issue by @mjang

Testing: I ran the Hugo server locally using make watch to ensure my project works properly

Please focus on (optional): .tgz change to .tar.gz in /content markdown files

Note: I ran make link-markdown and make link-check, but neither passed. I left it as is because they highlighted format issues beyond what my PR addresses. For example, there are issues with blockquote, dead links, e.t.c. But with your permission, I can work on them in another PR

If this PR addresses an issue on GitHub, ensure that you link to it here:

Closes #446

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content. ↩

@Dindihub Dindihub requested a review from a team as a code owner April 30, 2025 09:33
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nim NGINX Instance Manager product/nginxaas NGINX as a Service for Azure tooling Back end, repository, Hugo, and all things not related to content product/controller NGINX Controller (EOS product) product/nap-dos NGINX App Protect DOS product/nap-waf NGINX App Protect WAF product/nms NGINX Management Suite (EOS product) labels Apr 30, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 30, 2025 •
edited
Loading

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@Dindihub
Copy link
Author

I have hereby read the F5 CLA and agree to its terms

@Dindihub Dindihub changed the title Update Tarball extension from .tgz to tar.gz in markdown files docs: update tarball extension from .tgz to tar.gz in markdown files Apr 30, 2025
@ADubhlaoich
Copy link
Contributor

Note: I ran make link-markdown and make link-check, but neither passed. I left it as is because they highlighted format issues beyond what my PR addresses. For example, there are issues with blockquote, dead links, e.t.c. But with your permission, I can work on them in another PR

I wouldn't worry about this too much: they haven't been a mandatory part of PR work for a while and are due a revisit.

ADubhlaoich
ADubhlaoich requested changes Apr 30, 2025
View reviewed changes
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

The tarball changes LGTM but adding a full copy of the Hugo binaries is out of scope for the PR or the original issue.

JTorreG
JTorreG requested changes Apr 30, 2025
View reviewed changes
Copy link
Contributor

@JTorreG JTorreG left a comment

Choose a reason for hiding this comment

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

Please remove the changes to the makefile and the bin folder from this PR.

@Dindihub
Copy link
Author

The tarball changes LGTM but adding a full copy of the Hugo binaries is out of scope for the PR or the original issue.

You are right. Let me rebase. Thanks

@Dindihub Dindihub force-pushed the tarball-extension branch from e726069 to f719d79 Compare April 30, 2025 10:39
@Dindihub
Copy link
Author

The tarball changes LGTM but adding a full copy of the Hugo binaries is out of scope for the PR or the original issue.

Done @ADubhlaoich @JTorreG Please review. Thanks

JTorreG
JTorreG reviewed Apr 30, 2025
View reviewed changes
content/controller/admin-guides/backup-restore/backup-restore-cluster-config.md
@@ -19,7 +19,7 @@ After installing F5 NGINX Controller, you should back up the cluster config and
/opt/nginx-controller/helper.sh cluster-config save
```

The file is saved to `/opt/nginx-controller/cluster-config.tgz`.
The file is saved to `/opt/nginx-controller/cluster-config.tar.gz`.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not correct.

We have changed our guidelines, but the behavior of Controller has not changed. The product is not being updated so this change will probably never happen.

There are other instances of this same situation in this PR.

Copy link
Author

Choose a reason for hiding this comment

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

Apologies @JTorreG , I was not aware that the controller would not change. I understood the instructions to mean, I should make changes on all .tgz mentions in the markdown files . I'm new to nginx.

Do you mind pointing out instances that should remain .tgz? I'll be happy to make the changes. Thanks

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

@JTorreG JTorreG JTorreG requested changes

@ADubhlaoich ADubhlaoich ADubhlaoich requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation product/controller NGINX Controller (EOS product) product/nap-dos NGINX App Protect DOS product/nap-waf NGINX App Protect WAF product/nginxaas NGINX as a Service for Azure product/nim NGINX Instance Manager product/nms NGINX Management Suite (EOS product) tooling Back end, repository, Hugo, and all things not related to content
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update all gzip-compressed tarballs to have a tar.gz extension
3 participants
@Dindihub @ADubhlaoich @JTorreG