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

Prepare README and user guide #7

Merged
merged 10 commits into from
Jan 28, 2025

Conversation

kyasbal
Copy link
Member

@kyasbal kyasbal commented Jan 27, 2025

No description provided.

@kyasbal kyasbal marked this pull request as ready for review January 27, 2025 00:22
@kyasbal kyasbal requested a review from renamoo January 27, 2025 00:22
@kyasbal
Copy link
Member Author

kyasbal commented Jan 27, 2025

Fixing illustrations are not so complex. Feel free to point out anything if you find something to fix in images.

@kyasbal
Copy link
Member Author

kyasbal commented Jan 27, 2025

I added new images for query and the header.
I think it would be better to use animated GIF eventually, but I put 2 main screenshots on the top instead for a while.

Copy link
Collaborator

@renamoo renamoo left a comment

Choose a reason for hiding this comment

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

Maybe something like this to keep the header would be easier to see there is another option to get started, but it's nit, so leaving LGTM anyway.

## Get Started (Run from source)

<details>
<summary> Click to open steps to get started from source</summary>

@kyasbal
Copy link
Member Author

kyasbal commented Jan 27, 2025

Maybe something like this to keep the header would be easier to see there is another option to get started, but it's nit, so leaving LGTM anyway.

## Get Started (Run from source)

<details>
<summary> Click to open steps to get started from source</summary>

I agree with your opinion. I put the section header outside of the block.
The review become outdated. Please approve it again when you are free.

@kyasbal kyasbal requested a review from renamoo January 27, 2025 09:46
Copy link
Collaborator

@RyuSA RyuSA left a comment

Choose a reason for hiding this comment

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

let me leave some comment!!

@kyasbal kyasbal force-pushed the add-run-cloud-shell-button branch from ef78c6d to 3691e0e Compare January 27, 2025 12:42
@kyasbal kyasbal requested a review from RyuSA January 27, 2025 12:47
@kyasbal kyasbal changed the title Add user guide with illustration Prepare README and user guide Jan 27, 2025
@kyasbal
Copy link
Member Author

kyasbal commented Jan 28, 2025

We can merge this. But I'll wait @RyuSA 's opinion for in case.

@kyasbal kyasbal merged commit 8796ab0 into GoogleCloudPlatform:main Jan 28, 2025
1 check passed
@kyasbal kyasbal deleted the add-run-cloud-shell-button branch January 28, 2025 01:02
Copy link
Collaborator

@RyuSA RyuSA left a comment

Choose a reason for hiding this comment

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

LGTM👍

@kyasbal kyasbal mentioned this pull request Jan 28, 2025
4 tasks
@kyasbal kyasbal linked an issue Jan 28, 2025 that may be closed by this pull request
2 tasks
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.

Tracking bug of making this repository public
4 participants