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

Merged
merged 3 commits into from
Jan 23, 2025

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.

Copy link

codecov bot commented Jan 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.73%. Comparing base (b3dee9d) to head (33b5e55).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7191   +/-   ##
=======================================
  Coverage   52.73%   52.73%           
=======================================
  Files          89       89           
  Lines       20843    20843           
=======================================
  Hits        10992    10992           
  Misses       9394     9394           
  Partials      457      457           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ADubhlaoich ADubhlaoich merged commit ae73e34 into main Jan 23, 2025
32 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/nap-command-fixes branch January 23, 2025 16:26
nginx-bot pushed a commit that referenced this pull request Jan 23, 2025
* Fix mountPath directory for NAP5 policy documentation

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.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jakub Jarosz <[email protected]>
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: Done 🚀
Development

Successfully merging this pull request may close these issues.

4 participants