influxdata / influxdata/docs-v2

Add explicit detail about what's included in packages and tarballs when installing

Open
#4,153 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
82
Forks
326
Avg merge
1d 1h
Merged PRs (30d)
82

Description

The DB and CLI are separate entities but are sometimes packaged together and sometimes not.

- The tarball is just the DB. They will need to download, install, and put-in-path the CLI as well.
- The Linux packages install both by default via “recommends” (true for all Linux pkgs I’m assuming/hoping?). If users want just - - - The DB, they should run their install command with the --no-install-recommends flag (different for other non-Ubuntu/Deb?).
for Darwin, the DB comes alone as well. If the user wants the CLI, they should run brew install influxdb-cli

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the installation documentation covering tarballs, Linux packages, and Darwin. Verify which components each method installs and the commands for installing only the database or adding the CLI. Done means the package contents and CLI installation steps are explicit for each platform.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.