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.

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

Fix manifest CRD documentation #6197

Merged
merged 3 commits into from
Aug 14, 2024
Merged

Fix manifest CRD documentation #6197

merged 3 commits into from
Aug 14, 2024

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Aug 14, 2024

Proposed changes

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.

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

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 requested review from a team as code owners August 14, 2024 16:08
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Aug 14, 2024
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/nginx-ingress-controller/6197/

@ADubhlaoich ADubhlaoich merged commit a091018 into main Aug 14, 2024
49 checks passed
@ADubhlaoich ADubhlaoich deleted the fix-manifest-redundancy branch August 14, 2024 16:34
ADubhlaoich added a commit that referenced this pull request Aug 15, 2024
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation
Projects
Status: Done 🚀
Development

Successfully merging this pull request may close these issues.

3 participants