nginx / nginx/documentation

N1C doc improvements -- customer friendly

Open
#634 0 comments 0 reactions 1 assignee View on GitHub

@mjang is already working on this.

Since May 30, 2025.

documentation P3 - Normal (TTR: 1 month)
Dominant language
HTML
Stars
94
Forks
174
Avg merge
1d 10h
Merged PRs (30d)
66

Description

Overview

As a user of NGINX One Console, I want consistent info, based on what was presented to me when I first considered this product.

Description

Screenshots from discussions:

Image

  • Management plane: complementary
  • Next: view of Dashboard (doc might already exist with this data)
  • Review:
    • Availability: good: green = all online
    • Versions: Recommend: keep to a minimum (4 is OK
    • OSes: too many make life tricky
    • Certificates
    • Configuration recommendations: security opt, best practices
    • CVEs
      • can review in minutes
      • With ID on instances
      • Help determine whether to do now or later
      • Link to actual CVE
    • CPU utilization, similar to Splunk
    • Memory
    • Disk Space
    • Layer 7 "Unsuccessful response codes"

CVE screenshot

Image

  • Nice example of what happens in Edit Configuration screen
    • Details of specific directive

Image

Use case: "Staged Configs" -- If you do not want a config to be "active"
Use case: CSG (subset of instances)
Use case: Docker deployment

  • changes mod the running container
  • Docker container option for "Add Instance"
  • Image

Use case: ability to revert

  • We keep "the last 5 versions"

RBAC Use case: example, differnet teams, different locations, can limit access

  • Also r/o, r/w

Licensing list: available only via MyF5

  • deployments on MyF5, not yet

Acceptance criteria

Add any exacting acceptance criteria for the task to be complete. Start with known hard requirements, since they may create blockers.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.