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

[docs]: Minor additions to quickstart docs #153

Merged
merged 1 commit into from
Oct 22, 2021

Conversation

Callisto13
Copy link
Member

@Callisto13 Callisto13 commented Oct 20, 2021

Just a couple of small embellishments, including a toc

@Callisto13 Callisto13 added the kind/documentation Documentation only label Oct 20, 2021
@codecov-commenter
Copy link

Codecov Report

Merging #153 (f54684d) into main (12b503c) will decrease coverage by 0.62%.
The diff coverage is 21.27%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #153      +/-   ##
==========================================
- Coverage   40.09%   39.47%   -0.63%     
==========================================
  Files          32       32              
  Lines        1444     1477      +33     
==========================================
+ Hits          579      583       +4     
- Misses        789      818      +29     
  Partials       76       76              
Impacted Files Coverage Δ
infrastructure/firecracker/config.go 0.00% <0.00%> (ø)
infrastructure/firecracker/provider.go 0.00% <0.00%> (ø)
core/application/commands.go 64.93% <83.33%> (+1.92%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2941cce...f54684d. Read the comment docs.

yitsushi
yitsushi previously approved these changes Oct 21, 2021
Copy link
Contributor

@yitsushi yitsushi left a comment

Choose a reason for hiding this comment

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

Looks good. Now we have example payloads for create and delete under hack and a shell script to test create/delete endpoints.

docs/quick-start.md Outdated Show resolved Hide resolved
@Callisto13
Copy link
Member Author

oh yeh i wanted to update the link to the files you added 👍

yitsushi
yitsushi previously approved these changes Oct 22, 2021
- [Example](#example-1)
- [Troubleshooting](#troubleshooting)
- [flintlockd fails to start with <code>failed to reconcile vmid</code>](#flintlockd-fails-to-start-with-)
<!-- /toc -->
Copy link
Contributor

Choose a reason for hiding this comment

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

❤️ ❤️ ❤️

docs/quick-start.md Outdated Show resolved Hide resolved
@Callisto13
Copy link
Member Author

i've got some more fixes still to come so not merging yet

@Callisto13
Copy link
Member Author

@yitsushi question about the send.sh script.

do you have grpc-client-cli aliased as grpcurl? or did you mean to link a different project?

if it is grpc-client-cli, do you have an earlier version? the script does not work for me as-is. i have made some changes

@yitsushi
Copy link
Contributor

@Callisto13: No, it's the same. In the script prints out the command to install
if it's not available. That the grpcurl binary is coming from that go install.

❯ which grpcurl
/home/efertone/go/bin/grpcurl

@Callisto13
Copy link
Member Author

🤔 interesting, the go install (go install github.com/vadimi/grpc-client-cli/cmd/[email protected]) did not give me grpcurl anywhere. i just have home/claudia/go/bin/grpc-client-cli

@yitsushi
Copy link
Contributor

Hah... checked in a container and indeed it does install something else.

...looking at my zsh history...

@yitsushi
Copy link
Contributor

yitsushi commented Oct 22, 2021

I copied the wrong package there. I tried multiple applications if any of them
can work easily without the reflection.Register. Sorry for that.

The correct package is:

❯ docker run --rm -it golang:1.16-alpine /bin/ash
/go # go install github.com/fullstorydev/grpcurl/cmd/grpcurl@latest
go: downloading github.com/fullstorydev/grpcurl v1.8.5
go: downloading github.com/jhump/protoreflect v1.10.1
go: downloading google.golang.org/grpc v1.37.0
go: downloading google.golang.org/protobuf v1.25.1-0.20200805231151-a709e31e5d12
go: downloading github.com/golang/protobuf v1.4.2
go: downloading golang.org/x/net v0.0.0-20200625001655-4c5254603344
go: downloading google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013
go: downloading github.com/envoyproxy/go-control-plane v0.9.9-0.20210217033140-668b12f5399d
go: downloading github.com/google/uuid v1.1.2
go: downloading github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403
go: downloading golang.org/x/sys v0.0.0-20200331124033-c3d80250170d
go: downloading github.com/google/go-cmp v0.5.0
go: downloading github.com/envoyproxy/protoc-gen-validate v0.1.0
go: downloading golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d
go: downloading github.com/census-instrumentation/opencensus-proto v0.2.1
go: downloading golang.org/x/text v0.3.2
go: downloading golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543
go: downloading cloud.google.com/go v0.56.0
/go # ls bin/
grpcurl

@Callisto13
Copy link
Member Author

😎 updated the script, i am done with this now

@Callisto13 Callisto13 merged commit 12a354b into liquidmetal-dev:main Oct 22, 2021
@Callisto13 Callisto13 deleted the docs-additions branch October 22, 2021 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Documentation only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants