Skip to content

Actualized Dynamic modules info for NGINX Plus #430

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
Merged
y82 merged 6 commits into from
Apr 29, 2025
Merged

Actualized Dynamic modules info for NGINX Plus #430

y82 merged 6 commits into from
Apr 29, 2025

Conversation

@y82
Copy link
Contributor

@y82 y82 commented Apr 18, 2025

Proposed changes

This PR is a major update for the dynamic modules documentation in NGINX Plus:

  1. in "Installing NGINX Plus"
  • introduced tables for NGINX-authored, NGINX-certified modules with descriptions, links to the sources and to the dynamic module pages
  • added full info about Certified Partner modules (it was missing)
  • fixed default OS-specific paths to the /modules directory
  • fixed truncated filenames in "Compiling a dynamic module"
  1. in Dynamic Modules title page:
  • introduced a table for NGINX-authored and NGINX-certified modules with descriptions, links to the sources and to the dynamic module pages
  • fixed the output of apt-cache search
  • fixed paths to the os-specific default folder
  • info about dbg modules added
  • fixed wrong info about Certified Partner modules
  1. in "Uninstalling a dynamic module"
  • intro added
  • minor fixes
  1. The pages for removed modules updated accordingly
  2. Minor fix in the Otel nodule - file paths, etc

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. ↩

@y82 y82 requested a review from a team as a code owner April 18, 2025 20:29
@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 Apr 18, 2025
@y82 y82 self-assigned this Apr 18, 2025
ADubhlaoich
ADubhlaoich approved these changes Apr 22, 2025
View reviewed changes
Copy link
Member

@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.

Generally LGTM!

Please take a look at the frontmatter for those pages: our contemporary format can be seen in the archetypes:

https://raw.githubusercontent.com/nginx/documentation/refs/heads/main/archetypes/default.md

@y82 y82 merged commit 62c1938 into nginx:main Apr 29, 2025
6 checks passed
weli02 pushed a commit to weli02/documentation that referenced this pull request Apr 30, 2025
@y82 @weli02
Actualized Dynamic modules info for NGINX Plus (nginx#430)
5b9ae73 
* Updated Dynamic Modules sections in Installing NGINX Plus.

* Actualized dynamic modules landing page.

* Added intro, updated procedure for uninstall dynamic modules.

* Actualized info about removed dynamic modules.

* Minor updates to OpenTelemetry module.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ADubhlaoich ADubhlaoich ADubhlaoich approved these changes

Assignees

@y82 y82

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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@y82 @ADubhlaoich