Skip to content

Conversation

@mjang
Copy link
Contributor

@mjang mjang commented Jul 28, 2025

As suggested by @alessfg

Proposed changes

The docs for building the NGINX Plus Dockerfiles manually found here https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-docker#creating-custom-nginx-plus-docker-image need to be updated. Step 3 needs to mention downloading the JWT license in addition to the cert and key. The command in step 5 needs to be updated to:

docker build  --no-cache --secret id=nginx-key,src=nginx-repo.key --secret id=nginx-crt,src=nginx-repo.crt --secret id=nginx-jwt,src=license.jwt -t nginxplus .

Context

We may have a different problem, as we already cite these three files as prerequisites, per https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-docker/#prerequisites

But I get it:

  • We do need to update the command in step 5
  • In such a long page, it's hard to remember, "Oh yeah, there were those prerequisites some bunch of lines ago"

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

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.

@mjang mjang requested a review from a team as a code owner July 28, 2025 13:17
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginx-plus Issues related to NGINX Plus (and NGINX Open Source in docs.nginx.com) labels Jul 28, 2025
@github-actions
Copy link

Deploy Preview will be available once build job completes!

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

@mjang mjang requested a review from alessfg July 28, 2025 13:33
Copy link
Member

@alessfg alessfg left a comment

Choose a reason for hiding this comment

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

Seems like there was an extra whitespace :)

@mjang mjang requested a review from alessfg July 28, 2025 16:05
@alessfg
Copy link
Member

alessfg commented Jul 28, 2025

In such a long page, it's hard to remember, "Oh yeah, there were those prerequisites some bunch of lines ago"

In my experience when folks use this page they navigate to a specific subsection directly. It's useful to reiterate out the necessary requirements 😄

@mjang
Copy link
Contributor Author

mjang commented Jul 28, 2025

In such a long page, it's hard to remember, "Oh yeah, there were those prerequisites some bunch of lines ago"

In my experience when folks use this page they navigate to a specific subsection directly. It's useful to reiterate out the necessary requirements 😄

Modern technical writing follows a practice known as "Every Page is Page One". @alessfg what you say makes sense, so we may need to think about this further (for longer pages like this)

@mjang mjang merged commit fb2abfd into main Jul 28, 2025
10 checks passed
@mjang mjang deleted the mjang-patch-4 branch July 28, 2025 16:26
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/nginx-plus Issues related to NGINX Plus (and NGINX Open Source in docs.nginx.com)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants