-
Notifications
You must be signed in to change notification settings - Fork 7.3k
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
Cleanup README #2472
Cleanup README #2472
Conversation
@@ -46,15 +65,8 @@ If you’re using this demo, please **★Star** this repository to show your int | |||
``` | |||
|
|||
Substitute `<PROJECT_ID>` with the ID of your Google Cloud project. | |||
|
|||
4. Confirm the services have been enabled for your project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noting that I'm removing this redundant step, since the step above is not async and would tell you immediately if there was an error.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like — shortening time to completion.
@@ -1,21 +1,40 @@ | |||
<p align="center"> | |||
<!-- <p align="center"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noting that I'm commenting this image since it added quite a bit of extra scroll for the user to get to the README / docs / content. We can always re-add it at any time if we feel it should be there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this (removal of logo) — especially since:
- we don't really use this logo anywhere else (i.e., it's not essential)
- getting straight to the arch diagram is more important
cc: @NimJay merging this primarily due to the influx of traffic from the Next 24 dev keynote for those looking to try out the AI demo (which is nowhere to be found in the README at the moment). We can chat later on about any feedback / changes you'd like to see! |
This PR cleans up the README and puts it more in-line in terms of consistency with Bank of Anthos:
Staged: https://github.com/GoogleCloudPlatform/microservices-demo/blob/issue-cleanup-readme/README.md