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.

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

Include Compatibility matrix and update the readme #486

Merged
merged 1 commit into from
Dec 14, 2021
Merged

Include Compatibility matrix and update the readme #486

merged 1 commit into from
Dec 14, 2021

Conversation

mkumatag
Copy link
Member

@mkumatag mkumatag commented Dec 14, 2021 •
edited
Loading

What this PR does / why we need it:

  • Added Compatibility matrix
  • Removed all the unnecessary content and mentioned the hosted doc for the references

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #359

Special notes for your reviewer:

/area provider/ibmcloud

  1. Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.

Release note:

@k8s-ci-robot k8s-ci-robot added area/provider/ibmcloud Issues or PRs related to ibmcloud provider cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Dec 14, 2021
@netlify
Copy link

netlify bot commented Dec 14, 2021 •
edited
Loading

✔️ Deploy Preview for kubernetes-sigs-cluster-api-ibmcloud ready!

🔨 Explore the source changes: 87db5e8

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-sigs-cluster-api-ibmcloud/deploys/61b83b78446d170007bf6d77

😎 Browse the preview: https://deploy-preview-486--kubernetes-sigs-cluster-api-ibmcloud.netlify.app

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mkumatag

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 14, 2021
@mkumatag mkumatag changed the title Include Compatibility magrix and update the readme Include Compatibility matrix and update the readme Dec 14, 2021
@mkumatag
Copy link
Member Author

/cc @gyliu513

gyliu513
gyliu513 reviewed Dec 14, 2021
View reviewed changes
README.md
NAME INITIALIZED API SERVER AVAILABLE VERSION REPLICAS READY UPDATED UNAVAILABLE
ibm-vpc-0-control-plane true true v1.19.9 1 1 1
```
Please see our [book](https://cluster-api-ibmcloud.sigs.k8s.io) for in-depth documentation.
Copy link
Contributor

Choose a reason for hiding this comment

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

The book looks great, thanks @mkumatag !

README.md
@@ -2,23 +2,6 @@
[![Releases](https://img.shields.io/badge/version-v0.0.1-orange.svg)](https://sigs.k8s.io/cluster-api-provider-ibmcloud/releases "Cluster API provider IBM Cloud latest release")
[![Go Report Card](https://goreportcard.com/badge/sigs.k8s.io/cluster-api-provider-ibmcloud)](https://goreportcard.com/report/sigs.k8s.io/cluster-api-provider-ibmcloud)

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
Copy link
Contributor

Choose a reason for hiding this comment

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

DO we still want to keep the toc? Why remove it?

Copy link
Member Author

@mkumatag mkumatag Dec 14, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

we hardly have any content here in the readme to maintain the index, wdys?

@gyliu513
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 14, 2021
@k8s-ci-robot k8s-ci-robot merged commit 038f472 into kubernetes-sigs:main Dec 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gyliu513 gyliu513 gyliu513 left review comments

@relyt0925 relyt0925 Awaiting requested review from relyt0925

@wentao-zh wentao-zh Awaiting requested review from wentao-zh

Assignees

@gyliu513 gyliu513

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/provider/ibmcloud Issues or PRs related to ibmcloud provider cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document the compatibility metrics
3 participants
@mkumatag @k8s-ci-robot @gyliu513