N1C: define configuration recommendations
Open
Nobody has claimed this yet.
documentation
enhancement
P3 - Normal (TTR: 1 month)
product/nginx-one
- Dominant language
- HTML
- Stars
- 94
- Forks
- 174
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 66
Description
Overview
As a user of N1C, I want to understand more about the Configuration Recommendations. what qualifies as
- Security: refers to the implementation of protective settings and rules within the NGINX configuration files to defend the web server, applications, and data from unauthorized access, exploitation, and common web threats.
- Optimization: involves fine-tuning NGINX directives and settings to improve performance, reduce latency, and efficiently handle varying workloads based on traffic patterns and hardware.
- Best Practice: are standardized guidelines and recommended configurations aimed at ensuring security, stability, scalability, and maintainability of NGINX server setup.
- Other
Description
Task: documentation
Possible locations:
- Glossary
- Section in Instances / Config Sync Groups / Staged Configurations
- Candidate for "include" since they require the same content
Task: UI
- Update "info" text
Acceptance criteria
Definitions complete.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the Glossary and the Instances, Config Sync Groups, and Staged Configurations sections, including whether shared content belongs in an include. Check the current Configuration Recommendations info text in the UI. Done means the Security, Optimization, Best Practice, and Other definitions are complete and the info text is updated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nginx
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100