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

Update readme #2547

Merged
merged 4 commits into from
May 3, 2023
Merged

Update readme #2547

merged 4 commits into from
May 3, 2023

Conversation

MichalFupso
Copy link
Contributor

Description

For PR author

  • Tests for change.
  • If changing pkg/apis/, run make gen-files
  • If changing versions, run make gen-versions

For PR reviewers

A note for code reviewers - all pull requests must have the following:

  • Milestone set according to targeted release.
  • Appropriate labels:
    • kind/bug if this is a bugfix.
    • kind/enhancement if this is a a new feature.
    • enterprise if this PR applies to Calico Enterprise only.

@CLAassistant
Copy link

CLAassistant commented Mar 13, 2023

CLA assistant check
All committers have signed the CLA.

README.md Outdated
@@ -7,6 +7,19 @@ to make installation, upgrades, and ongoing lifecycle management of Calico and C

This operator is built using the [operator-sdk](https://github.com/operator-framework/operator-sdk), so you should be familiar with how that works before getting started.

## Getting Started Running Calico

There are many avenues to get started running Caico depending on your situation.
Copy link
Member

Choose a reason for hiding this comment

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

Caico -> Calico

README.md Outdated
- [IBM Cloud Kubernetes Service (IKS)](https://docs.tigera.io/calico/3.25/getting-started/kubernetes/managed-public-cloud/iks)
- [Microsoft Azure Kubernetes Service (AKS)](https://docs.tigera.io/calico/3.25/getting-started/kubernetes/managed-public-cloud/aks)
- Want to go deeper? Visit [https://docs.tigera.io/](https://docs.tigera.io/) for full documentation.

Copy link
Member

Choose a reason for hiding this comment

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

nit: Excess empty lines

@MichalFupso
Copy link
Contributor Author

@rene-dekker Addressed your comments

@tmjd
Copy link
Member

tmjd commented Apr 26, 2023

These links should go to the latest docs, so they will stay up-to-date, instead of linking to a specific version of the docs.

Copy link
Member

@tmjd tmjd left a comment

Choose a reason for hiding this comment

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

LGTM

@tmjd tmjd merged commit 67e4760 into tigera:master May 3, 2023
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.

6 participants