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

Number of issues with ReadMe manual #165

Open
MDullak opened this issue Jan 24, 2024 · 1 comment
Open

Number of issues with ReadMe manual #165

MDullak opened this issue Jan 24, 2024 · 1 comment
Labels
defect Suspected defect such as a bug or regression

Comments

@MDullak
Copy link

MDullak commented Jan 24, 2024

What version were you using?

0.14.1

What environment was the server running in?

Clean K3S install + kubernetes dashboards

Is this defect reproducible?

Yes it is reproducable

  1. in the ReadMe the storage for Stream is memory, in the file that is mentioned (https://raw.githubusercontent.com/nats-io/nack/main/deploy/examples/stream.yml) the type is file
  2. installing nats via helm installs nats-box already, the ReadMe asks to deploy file: https://nats-io.github.io/k8s/tools/nats-box.yml which is nats-box, but the file does not exists
  3. using nats-box deployed by helm install nats, makes it impossible to add context as per manual /etc/nats-context is mounted RO and can not be remounted to RW (premission denied although I am root)

Given the capability you are leveraging, describe your expectation?

As a beginer I would expect that the ReadMe is up to date so that I can try out nats and nack by following the ReadMe.
Looks like ReadMe might be outdated. This makes it hard for NATS noob like myself to give it a try.

Given the expectation, what is the defect you are observing?

I can not send and recieve messages by following the ReadMe. I would love to see that it works before I start creating my own usage scenarios.

@MDullak MDullak added the defect Suspected defect such as a bug or regression label Jan 24, 2024
@Jarema
Copy link
Member

Jarema commented Jan 30, 2024

Hey!
Thanks for filling the issue.
We updates some of the readme recently, but it seems - not everywhere.
We will fix it.

Are you interested in contributions with issues you already found?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
defect Suspected defect such as a bug or regression
Projects
None yet
Development

No branches or pull requests

2 participants