-
Notifications
You must be signed in to change notification settings - Fork 502
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
docs: add cleanPolicy enum values #6064
base: master
Are you sure you want to change the base?
docs: add cleanPolicy enum values #6064
Conversation
* adds `cleanPolicy` enum values to the api reference documentation as described in the public website https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-restore-cr
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Welcome @george-e-shaw-iv! It looks like this is your first PR to pingcap/tidb-operator 🎉 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #6064 +/- ##
==========================================
- Coverage 57.19% 55.70% -1.50%
==========================================
Files 259 266 +7
Lines 33233 46185 +12952
==========================================
+ Hits 19008 25727 +6719
- Misses 12291 18450 +6159
- Partials 1934 2008 +74
|
The api reference documentation is generated from the CRD Golang comments, you need to update the |
I'm waiting on my company (Atlassian) to approve me signing the CLA and then I'll fix this PR and sign the SLA so it can be merged. |
cleanPolicy
enum values to the api reference documentation as described in the public website https://docs.pingcap.com/tidb-in-kubernetes/stable/backup-restore-crWhat problem does this PR solve?
Documentation does not state what the valid values of
cleanPolicy
is.What is changed and how does it work?
Added documentation that lists and describes the valid values of
cleanPolicy
.Code changes
Tests
Side effects
Related changes
Release Notes
Please refer to Release Notes Language Style Guide before writing the release note.