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

CLOUDP-222191: Update quick start guide and provided samples #1421

Merged
merged 5 commits into from
Mar 18, 2024

Conversation

helderjs
Copy link
Collaborator

@helderjs helderjs commented Mar 4, 2024

All Submissions:

  • Have you signed our CLA?
  • Put closes #XXXX in your comment to auto-close the issue that your PR fixes (if there is one).
  • Update docs/release-notes/release-notes.md if your changes should be included in the release notes for the next release.

I replaced the hard-coded examples with references from inside our config sample folder. Ensuring both work

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@s-urbaniak
Copy link
Collaborator

@s-urbaniak
Copy link
Collaborator

@helderjs that's a great start, thank you! I have a couple of comments and a question regarding the CSV.

@helderjs
Copy link
Collaborator Author

helderjs commented Mar 5, 2024

What do we do about the quickstart guide in the CSV? https://github.com/mongodb/mongodb-atlas-kubernetes/blob/main/config/manifests/bases/mongodb-atlas-kubernetes.clusterserviceversion.yaml#L70-L176

Thanks for reminding me about it. Looks like it was never updated, the information there was from before GA 😬

@helderjs helderjs requested a review from s-urbaniak March 5, 2024 13:04
README.md Outdated
Before you install the MongoDB Atlas Operator using `kubectl`, you must:

1. Install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
2. Have Kubernetes installed, i.e. [Kind](https://kind.sigs.k8s.io/)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Or have access to a kubernetes cluster configuration right?

Copy link
Collaborator

@josvazg josvazg left a comment

Choose a reason for hiding this comment

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

LGTM, I assume we have followed the new steps successfully right?

@s-urbaniak
Copy link
Collaborator

The CSV contains copy&paste from the README. We need a ratified version by @dan-mckean here instead.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Sergiusz Urbaniak <sergiusz.urbaniak@gmail.com>
@helderjs helderjs merged commit 5e7d5ce into main Mar 18, 2024
9 checks passed
@helderjs helderjs deleted the update-quick-start-guide branch March 18, 2024 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants