Skip to content

Simplify readability for NGINX Plus Admin Guide: Gateway with uWSGI and Django #518

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 4 commits into
base: main
Choose a base branch
from
Open

Simplify readability for NGINX Plus Admin Guide: Gateway with uWSGI and Django #518

wants to merge 4 commits into from
+50 −51

Conversation

kmjaimes
Copy link

@kmjaimes kmjaimes commented May 4, 2025

Proposed changes

Problem: Article is listed as "difficult" to read.

Solution: Use Hemingway App to drop readability score from 10 to 9. Fleisch Kinkaid estimate from 14.46 to 8.2.

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

Closes Issue #359

@kmjaimes kmjaimes requested a review from a team as a code owner May 4, 2025 22:43
@github-actions GitHub Actions
Copy link

github-actions bot commented May 4, 2025 •
edited
Loading

🎉 Thank you for your contribution! It appears you have not yet signed the F5 Contributor License Agreement (CLA), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the F5 CLA and reply on a new comment with the following text to agree:

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

1 out of 2 committers have signed the CLA.
✅ (kmjaimes)[https://github.com/kmjaimes]
❌ @kristen Jaimes
Kristen Jaimes seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com) labels May 4, 2025
@kmjaimes
Copy link
Author

kmjaimes commented May 4, 2025 •
edited by mjang
Loading

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

@kmjaimes
Copy link
Author

kmjaimes commented May 4, 2025

recheck

1 similar comment
@mjang
Copy link
Contributor

mjang commented May 4, 2025

recheck

mjang
mjang approved these changes May 5, 2025
View reviewed changes
Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

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

I love the improvements! I have a couple of suggested changes. If you'd like to talk about it while we're at the conference, let me know!

content/nginx/admin-guide/web-server/app-gateway-uwsgi-django.md Outdated

Serving of static content is offloaded to NGINX or NGINX Plus, which serves it directly from **/var/django/projects/myapp/static**. Traffic to the application at **/main** is proxied and bridged from HTTP to the uwsgi protocol and passed to the Django app running inside a uWSGI application container.
NGINX or NGINX Plus serves static files from /var/django/projects/myapp/static. NGINX sends /main traffic to the Django app by converting it from HTTP to the uwsgi protocol.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
NGINX or NGINX Plus serves static files from /var/django/projects/myapp/static. NGINX sends /main traffic to the Django app by converting it from HTTP to the uwsgi protocol.
NGINX or NGINX Plus serves static files from **/var/django/projects/myapp/static**. NGINX sends /main traffic to the Django app by converting it from HTTP to the uWSGI protocol.

Copy link
Author

Choose a reason for hiding this comment

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

Change applied.

content/nginx/admin-guide/web-server/app-gateway-uwsgi-django.md Outdated
}
}
```

Notice that the configuration defines an upstream called **django**. The port number on the server in the group, 29000, matches the one the uWSGI server binds to, as specified by the `socket` argument in the sample `uwsgi` command.
Notice that the configuration defines an upstream called django, with a server containing the port number `29000`. It matches the port specified by the `socket` argument in the sample `uwsgi` command. The uWSGI server binds to this port.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Notice that the configuration defines an upstream called django, with a server containing the port number `29000`. It matches the port specified by the `socket` argument in the sample `uwsgi` command. The uWSGI server binds to this port.
Notice that the configuration defines an upstream called Django, with a server containing the port number `29000`. It matches the port specified by the `socket` argument in the sample `uwsgi` command. The uWSGI server binds to this port.

Copy link
Author

Choose a reason for hiding this comment

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

Change applied.

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

@mjang mjang mjang approved these changes

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kmjaimes @mjang