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 mountPath directory for NAP5 policy documentation #7191

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Jan 22, 2025

Proposed changes

This commit updates the path for the volumeMounts shown in the NAP5 compile documentation to use the newest convention, and also adds a missing parameter from the kubectl cp example at the end of the page.

Issue reported by Fabrizio Fiorucci, as it can cause confusion and possible error for a reader following along and reading the NAP documentation concurrently.

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 updates the path for the volumeMounts shown in the NAP5
compile documentation to use the newest convention, and also adds a
missing parameter from the `kubectl cp` example at the end of the page.

Issue reported by Fabrizio Fiorucci, as it can cause confusion and
possible error for a reader following along and reading the NAP
documentation concurrently.
@ADubhlaoich ADubhlaoich requested review from a team as code owners January 22, 2025 15:59
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Jan 22, 2025
@ADubhlaoich ADubhlaoich added the needs cherry pick Cherry pick this PR into a release branch label Jan 22, 2025
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/7191/

@ADubhlaoich
Copy link
Contributor Author

Fabrizio has indicated that a user will also need to copy a logging profile bundle as part of this process.

The final section of this page is written in a generic enough way to show the user what command to use: they're expected to know what they need to copy.

The logging profile bundle isn't actually mentioned anywhere in the existing text, so I'm unsure what modifications would need to be made for it to have the correct context.

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 needs cherry pick Cherry pick this PR into a release branch
Projects
Status: Todo ☑
Development

Successfully merging this pull request may close these issues.

1 participant