Improve CI/CD settings documentation (pt.4)
What does this MR do and why?
This MR continues the improvements to the CI/CD settings documentation in the Admin area by applying a task-oriented approach to the remaining sections: package registry, runners, job token permissions, and job logs.
These changes make the documentation more user-friendly by:
- Making it easier for users to quickly find the specific tasks they want to accomplish.
- Providing clear, consistent instructions that focus on what users can do.
- Ensuring consistency in terminology and structure throughout the document.
Changes
- Converted section headings to follow the task topic type.
- Standardized language for describing default states and how to change them.
- Improved procedural instructions with clear steps and consistent formatting.
- Added missing sections for package registry settings:
- Skip NuGet package metadata URL validation
- Set maximum Helm packages per channel
- Reorganized content for better flow and readability.
- Updates anchor links in the docs and in the UI help paths.
Sections updated
This MR focuses on the following sections:
-
- Skip NuGet package metadata URL validation (new section)
- Set maximum Helm packages per channel (new section)
- Set package file size limits
- Control package forwarding
-
- Control runner version management
- Control runner registration
- Restrict runner registration for a specific group
-
- Enforce job token allowlist
-
- Configure incremental logging
Review app link
References
- Pt. 1: Restructure CI/CD Admin settings documentation (!188635 - merged) (structural and organizational changes)
- Pt. 2: Improve CI/CD settings documentation (pt.2) (!189102 - merged) (improves continuous integration and delivery settings)
- Pt. 3: Improve CI/CD settings documentation (pt.3) (!189233 - merged) (improves pipelines settings under continuous integration and delivery)
Screenshots or screen recordings
| Before | After |
|---|---|
 |
 |
Edited by Lysanne Pinto