Skip to content
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

Fix manifest CRD documentation #6208

Merged
merged 1 commit into from
Aug 15, 2024
Merged

Fix manifest CRD documentation #6208

merged 1 commit into from
Aug 15, 2024

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Aug 15, 2024 •
edited
Loading

Proposed changes

Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to
that issue here in this description (not in the title of the PR).

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@ADubhlaoich
Fix manifest CRD documentation (#6197)
5d299dc 
This commit restructures the custom resource section of the Installation
with Manifests documentation to remove redundant instructions and more
clearly delineate the NAP-specific instructions from the core
definitions.

Using includes, a potential furthur improvement for the future would be
to fully compartmentalise any NAP WAF or DOS documentation into their
"Integration" subsections, removing them from the critical user path.
@ADubhlaoich ADubhlaoich self-assigned this Aug 15, 2024
@ADubhlaoich ADubhlaoich requested review from a team as code owners August 15, 2024 11:47
@github-actions github-actions bot added documentation Pull requests/issues for documentation dependencies Pull requests that update a dependency file go Pull requests that update Go code python Pull requests that update Python code github_actions Pull requests that update Github_actions code docker Pull requests that update Docker code helm_chart Pull requests that update the Helm Chart labels Aug 15, 2024
@ADubhlaoich ADubhlaoich changed the base branch from main to release-3.6 August 15, 2024 11:47
@ADubhlaoich ADubhlaoich reopened this Aug 15, 2024
@github-actions github-actions bot removed dependencies Pull requests that update a dependency file go Pull requests that update Go code python Pull requests that update Python code github_actions Pull requests that update Github_actions code docker Pull requests that update Docker code helm_chart Pull requests that update the Helm Chart labels Aug 15, 2024
@ADubhlaoich ADubhlaoich merged commit 4da85d5 into release-3.6 Aug 15, 2024
43 checks passed
@ADubhlaoich ADubhlaoich deleted the pick-manifests-fix branch August 15, 2024 14:15
@pdabelf5 pdabelf5 changed the title [cherry-pick] Fix manifest CRD documentation Fix manifest CRD documentation Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jjngx jjngx jjngx approved these changes

@vepatel vepatel vepatel approved these changes

Assignees

@ADubhlaoich ADubhlaoich

Labels
documentation Pull requests/issues for documentation
Projects
NGINX Ingress Controller
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ADubhlaoich @vepatel @jjngx