-
Notifications
You must be signed in to change notification settings - Fork 30
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
Add outstanding README contents #556
Conversation
This is a work in progress, but pushing up for reference, for now.
- [rust](https://www.rust-lang.org/) | ||
- [just](https://github.com/casey/just) | ||
- [helm](https://helm.sh/) | ||
- Opentelemetry collector (**optional**) |
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.
Most of these are somewhat necessary, but I found the telemetry stuff to get in the way of comprehension as a first-time reader.
|
||
### Rust Linting |
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.
The linting stuff seems unrelated to a first-run experience. Maybe move into contributing, or further down the document.
|
||
```bash | ||
rustup toolchain install nightly | ||
rustup component add rustfmt --toolchain nightly |
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.
Frankly, I don't think the nightly stuff is needed at all any more; things seem to work just fine with the stable release tooling.
|
||
|
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.
After this is running, the kubectl apply
command should be usable to just run a stack locally and connect with psql
. This stuff comes literally last in this document. Most things between here and there seem to cover other use cases. They may be valuable, but as a first-time reader, I was mostly here for "I want to run locally". The next thing I would find interesting as a new dev is the cargo watch
stuff, probably.
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
Signed-off-by: Evan Stanton <evan.h.stanton@gmail.com>
This is a work in progress, but pushing up for reference, for now.
This isn't intended for merge, but to share some of the changes I made and discussed last week with @EvanHStanton