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

Add api docs #5605

Merged
merged 7 commits into from
Dec 9, 2022
Merged

Add api docs #5605

merged 7 commits into from
Dec 9, 2022

Conversation

JimBugwadia
Copy link
Member

@JimBugwadia JimBugwadia commented Dec 7, 2022

Explanation

Start API docs for developers

Related issue

Fixes #5607

Milestone of this PR

What type of PR is this

Proposed Changes

Proof Manifests

Checklist

  • I have read the contributing guidelines.
  • I have read the PR documentation guide and followed the process including adding proof manifests to this PR.
  • This is a bug fix and I have added unit tests that prove my fix is effective.
  • This is a feature and I have added CLI tests that are applicable.
  • My PR needs to be cherry picked to a specific release branch which is .
  • My PR contains new or altered behavior to Kyverno and
    • CLI support should be added and my PR doesn't contain that functionality.
    • I have added or changed the documentation myself in an existing PR and the link is:
    • I have raised an issue in kyverno/website to track the documentation update and the link is:

Further Comments

Signed-off-by: Jim Bugwadia <jim@nirmata.com>
Signed-off-by: Jim Bugwadia <jim@nirmata.com>
Signed-off-by: Jim Bugwadia <jim@nirmata.com>
@codecov
Copy link

codecov bot commented Dec 7, 2022

Codecov Report

Merging #5605 (754a390) into main (8376bf8) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #5605   +/-   ##
=======================================
  Coverage   36.39%   36.39%           
=======================================
  Files         174      174           
  Lines       19154    19154           
=======================================
  Hits         6971     6971           
  Misses      11404    11404           
  Partials      779      779           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@realshuting realshuting left a comment

Choose a reason for hiding this comment

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

We can discuss Kyverno API management in the contributors meeting.

docs/dev/api/README.md Outdated Show resolved Hide resolved
@realshuting
Copy link
Member

realshuting commented Dec 7, 2022

We can discuss Kyverno API management in the contributors meeting.

I saw a related discussion has been added to our agenda, great!

Copy link
Member

@realshuting realshuting left a comment

Choose a reason for hiding this comment

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

/lgtm

@JimBugwadia JimBugwadia enabled auto-merge (squash) December 9, 2022 03:05
@JimBugwadia JimBugwadia merged commit 1efa8b1 into kyverno:main Dec 9, 2022
MdSahil-oss pushed a commit to MdSahil-oss/kyverno that referenced this pull request Dec 29, 2022
* add doc

Signed-off-by: Jim Bugwadia <jim@nirmata.com>

* add doc

Signed-off-by: Jim Bugwadia <jim@nirmata.com>

* updates from review

Signed-off-by: Jim Bugwadia <jim@nirmata.com>

Signed-off-by: Jim Bugwadia <jim@nirmata.com>
Co-authored-by: shuting <shuting@nirmata.com>
Signed-off-by: Md Sahil <Mohdssahil1@gmail.com>
@JimBugwadia JimBugwadia deleted the add_api_docs branch January 11, 2023 00:37
MdSahil-oss pushed a commit to MdSahil-oss/kyverno that referenced this pull request Jan 11, 2023
* add doc

Signed-off-by: Jim Bugwadia <jim@nirmata.com>

* add doc

Signed-off-by: Jim Bugwadia <jim@nirmata.com>

* updates from review

Signed-off-by: Jim Bugwadia <jim@nirmata.com>

Signed-off-by: Jim Bugwadia <jim@nirmata.com>
Co-authored-by: shuting <shuting@nirmata.com>
Signed-off-by: MdSahil-oss <Mohdssahil1@gmail.com>
MdSahil-oss pushed a commit to MdSahil-oss/kyverno that referenced this pull request Jan 11, 2023
* add doc

Signed-off-by: Jim Bugwadia <jim@nirmata.com>

* add doc

Signed-off-by: Jim Bugwadia <jim@nirmata.com>

* updates from review

Signed-off-by: Jim Bugwadia <jim@nirmata.com>

Signed-off-by: Jim Bugwadia <jim@nirmata.com>
Co-authored-by: shuting <shuting@nirmata.com>
Signed-off-by: MdSahil-oss <Mohdssahil1@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create API guide for developers
2 participants