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

Migrate access control example to documentation website #6572

Merged
merged 25 commits into from
Oct 21, 2024

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Oct 2, 2024

Proposed changes

This pull request migrates the access control example to the documentation website, converting the existing README into a page formatted for the production website. It also cleans up the frontmatter of the surrounding documents so that pages can be more easily re-arranged in the future.

The converted page makes use of single source embedded code blocks using files in the GitHub repository, as well as a highlighting feature of code blocks that has not been used in previous documentation.

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 migrates the access control example to the documentation
website, converting the existing README into a page formatted for the
production website. It also cleans up the frontmatter of the surrounding
documents so that pages can be more easily re-arranged in the future.

The converted page make use of single source embedded code blocks using
files in the GitHub repository, as well as a highlighting feature of
code blocks that has not been used in previous documentation.
@ADubhlaoich ADubhlaoich requested review from a team as code owners October 2, 2024 11:17
@ADubhlaoich ADubhlaoich self-assigned this Oct 2, 2024
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Oct 2, 2024
@ADubhlaoich ADubhlaoich added the needs cherry pick Cherry pick this PR into a release branch label Oct 2, 2024
Copy link

github-actions bot commented Oct 2, 2024

Deploy Preview will be available once build job completes!

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

Copy link

codecov bot commented Oct 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.00%. Comparing base (e750d84) to head (91387ef).
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6572      +/-   ##
==========================================
- Coverage   53.08%   53.00%   -0.08%     
==========================================
  Files          87       87              
  Lines       16200    16223      +23     
==========================================
  Hits         8599     8599              
- Misses       7194     7217      +23     
  Partials      407      407              

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

@ADubhlaoich ADubhlaoich mentioned this pull request Oct 11, 2024
6 tasks
@ADubhlaoich ADubhlaoich enabled auto-merge (squash) October 21, 2024 14:44
@ADubhlaoich ADubhlaoich merged commit a11c094 into main Oct 21, 2024
30 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/example-migration branch October 21, 2024 14:45
nginx-bot pushed a commit that referenced this pull request Oct 21, 2024
This commit migrates the access control example to the documentation
website, converting the existing README into a page formatted for the
production website. It also cleans up the frontmatter of the surrounding
documents so that pages can be more easily re-arranged in the future.

The converted page make use of single source embedded code blocks using
files in the GitHub repository, as well as a highlighting feature of
code blocks that has not been used in previous documentation.

Co-authored-by: Jodie Putrino <[email protected]>
Co-authored-by: Venktesh Shivam Patel <[email protected]>
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.

7 participants