Skip to content

doc: reporting a couple confusions in dependencies installation #666

@darosior

Description

@darosior

Following https://github.com/bitcoin-dev-project/warnet/blob/main/docs/install.md on my own to test the docs. I'm running Debian stable.

I followed "Running warnet locally" > "Docker desktop". Then i followed "Testing kubectl and helm" to ensure my dependencies install was correct before moving on to installing Warnet itself. I was confused that it tells to try kubectl command when i wasn't instructed to install it. Also the helm install command failed for some reason.

Asking @pinheadmz it turns out all this wasn't actually necessary since the next step takes care to install helm and kubectl locally in my virtual env.

Conclusion: the simplest route should probably be emphasized in the doc. Install Docker Desktop, create a Python venv, pip install warnet, warnet setup, done. Installing the deps globally can still be discussed but it should probably not be the default route when following the docs?

Side note: my first warnet setup failed because i didn't enable Kubernetes in the settings of Docker desktop, might be worth mentioning it's necessary. Although the error i got was very clear and the fix straightforward.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions