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-185079: notify users about new SDK #499

Merged
merged 5 commits into from Jun 20, 2023
Merged

CLOUDP-185079: notify users about new SDK #499

merged 5 commits into from Jun 20, 2023

Conversation

wtrocki
Copy link
Member

@wtrocki wtrocki commented Jun 16, 2023

Description

Since we have other SDK in GA state we need to flag in the old repository.
Putting a message into Readme.md will be good start.

This PR needs docs review

Link to any related issue(s):

Type of change:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Required Checklist:

  • I have signed the MongoDB CLA
  • I have added tests that prove my fix is effective or that my feature works
  • I have added any necessary documentation (if appropriate)
  • I have run make fmt and formatted my code

Further comments

@wtrocki wtrocki requested a review from a team as a code owner June 16, 2023 10:14
README.md Outdated
@@ -6,6 +6,11 @@ A Go HTTP client for the [MongoDB Atlas API](https://docs.atlas.mongodb.com/api/

Note that `go-client-mongodb-atlas` only supports the two most recent major versions of Go.

## Maintenance Update
Copy link
Member Author

Choose a reason for hiding this comment

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

We need to be careful with crafting the proper message.

@wtrocki
Copy link
Member Author

wtrocki commented Jun 16, 2023

FYI @mongodb/api-docs we need to be careful with the mesage here.

Copy link
Contributor

@sarahsimpers sarahsimpers left a comment

Choose a reason for hiding this comment

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

A few suggestions on wording then LGTM

README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@andreaangiolillo andreaangiolillo left a comment

Choose a reason for hiding this comment

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

Holding this until official GA

Co-authored-by: Sarah Simpers <82042374+sarahsimpers@users.noreply.github.com>
@wtrocki
Copy link
Member Author

wtrocki commented Jun 20, 2023

@andreaangiolillo following your concerns do you think it would be possible to slightly modify description or make it work for your team while also informing new users about new Atlas SDK?

@wtrocki wtrocki merged commit 09206e3 into master Jun 20, 2023
3 checks passed
@wtrocki wtrocki deleted the CLOUDP-185079 branch June 20, 2023 17:18
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.

None yet

4 participants