8000 Document option for installing CRDs from a single remote yaml by shaun-nx · Pull Request #4730 · nginx/kubernetes-ingress · GitHub
[go: up one dir, main page]
Skip to content

Document option for installing CRDs from a single remote yaml #4730

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
Merged
merged 9 commits into from
Dec 6, 2023
Merged

Document option for installing CRDs from a single remote yaml #4730

merged 9 commits into from
Dec 6, 2023

Conversation

shaun-nx
Copy link
Contributor
@shaun-nx shaun-nx commented Dec 1, 2023 •
edited
Loading

Proposed changes

This PR updates our installation with manifest docs to include the option for installing our CRDs from a single yaml file through a remote
URL.

Additional changes:

  • Remove steps to cd into deployments directory. This is because not all relevant manifests are in that directory now.
  • Add additional context for using installing CRDs using a URL.
  • Explicitly call out the need to clone the repo when not installing CRDs using a URL.

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

@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Dec 1, 2023
@shaun-nx shaun-nx linked an issue Dec 1, 2023 that may be closed by this pull request
Update documentation to highlight use of single CRD yaml #4678
Closed
@shaun-nx shaun-nx marked this pull request as ready for review December 1, 2023 12:16
@shaun-nx shaun-nx requested review from a team as code owners December 1, 2023 12:16
@codecov Codecov
Copy link
codecov bot commented Dec 1, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (37897fc) 52.06% compared to head (d2e768f) 52.09%.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #4730      +/-   ##
==========================================
+ Coverage   52.06%   52.09%   +0.02%     
==========================================
  Files          59       59              
  Lines       17033    17033              
==========================================
+ Hits         8869     8873       +4     
+ Misses       7864     7862       -2     
+ Partials      300      298       -2

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

@shaun-nx shaun-nx requested review from jputrino and vepatel December 5, 2023 10:46
ADubhlaoich
ADubhlaoich approved these changes Dec 5, 2023
View reviewed changes
Copy link
Contributor
@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@shaun-nx shaun-nx merged commit 4c1eef7 into main Dec 6, 2023
@shaun-nx shaun-nx deleted the docs/single-crd branch December 6, 2023 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ADubhlaoich ADubhlaoich ADubhlaoich approved these changes

@vepatel vepatel vepatel approved these changes

@jputrino jputrino Awaiting requested review from jputrino

Assignees
No one assigned
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update documentation to highlight use of single CRD yaml
4 participants
@shaun-nx @ADubhlaoich @jputrino @vepatel
0