Documentation update for issue #920 #130
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Attempt to resolve issue 920
The user intends to incorporate practical, example-driven content from a blog post into the official NGINX documentation to make it more comprehensive, user-friendly, and aligned with current best practices. Among the potential documents, the most relevant are the existing documentation pages that cover core concepts, such as the overview of metrics, dashboards, and configuration, as well as specific sections on metrics API, dashboards, and security policies. Since the blog post content is highly example-driven and detailed, the best approach is to create a new dedicated page or section that consolidates these practical examples, or to enhance existing pages with these examples if they are related. Given the current documents, the most suitable is to add a new page under the metrics or dashboards section, or to embed the examples into the existing overview or metrics pages. The goal is to improve usability and clarity by providing concrete examples, which are currently missing or limited. The existing documents do not seem to contain detailed, step-by-step examples of how to use the metrics API, dashboards, or security policies with real-world scenarios, so creating a new dedicated page or section for "Practical Examples" is the best plan. This will help users find actionable, example-driven content in one authoritative resource, fulfilling the intent.
The documents that need updating are primarily the metrics API, dashboards, and security concepts pages, but since the potential documents are limited and do not include a dedicated "examples" page, the best plan is to create a new page for "Practical Examples" and link it from relevant sections. The existing pages can be updated to include references or links to this new resource.
The plan is to:
Since the user request is to produce a change plan for the existing documents, and the potential documents are mostly informational pages, the most effective approach is to add a new example resource and link to it from relevant pages.