CLOUDP-112242: Updated README.MD #1001
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andreaangiolillo
requested review from
a team,
dianchenghu,
gssbzn and
sarahsimpers
blva
previously approved these changes
Mar 1, 2022
andreaangiolillo
commented
Mar 1, 2022
gssbzn
reviewed
Mar 1, 2022
gssbzn
suggested changes
Mar 1, 2022
Contributor
gssbzn
left a comment
gssbzn
left a comment
There was a problem hiding this comment.
not sure what your end goal was with this change but if it was to expose Atlas CLI at least for me it's not working as expected.
The README it's becoming too much to parse and too much to scroll if I'm only interested in atlas cli.
Some alternatives to consider.
- Create a
mongocli.mdand aatlascli.mdREAMEs and link to them from the main README - Delete all content that exists somewhere else and leave only the essential, how to install, login, usage, link all to public docs, requirements about go and install from souce exist in the contributing file can be deleted. Probably also delete both gifs. TL;DR leave the readme a barebone of what the CLIs are link to publci docs for anything else
JuliaMongo
reviewed
Mar 1, 2022
Contributor
JuliaMongo
left a comment
JuliaMongo
left a comment
There was a problem hiding this comment.
LGTM for copy review with these comments.
gssbzn
reviewed
Mar 2, 2022
Contributor
gssbzn
left a comment
gssbzn
left a comment
There was a problem hiding this comment.
Thanks for the split of files, I think it makes a difference on organising the instructions, left some small comments to address before merging
gssbzn
previously approved these changes
Mar 3, 2022
Contributor
gssbzn
left a comment
gssbzn
left a comment
There was a problem hiding this comment.
LGTM thanks for those changes
sarahsimpers
previously approved these changes
Mar 4, 2022
Contributor
sarahsimpers
left a comment
sarahsimpers
left a comment
There was a problem hiding this comment.
LGTM % one optional nit for language.
andreaangiolillo
dismissed stale reviews from sarahsimpers and gssbzn
via
70618eb
blva
approved these changes
Mar 7, 2022
gssbzn
approved these changes
Mar 7, 2022
fmenezes
approved these changes
Mar 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Jira ticket: CLOUDP-112242
Checklist
make fmtand formatted my codeFurther comments
This PR updates the
README.MDto include atlascli. The newREADMEis available here https://github.com/mongodb/mongocli/tree/CLOUDP-112242.This PR will be merged once we have pre-released atlascli and renamed the repository to mongodb-atlas-cli
Next Step:
atlascli v0.0.1mongodb-atlas-cliatlascli v1.0.0atlascli.mdto add documentation links