Local tutorial corrections
- Dominant language
- Go
- Stars
- 283
- Forks
- 148
- PR merge metrics
- No merged PRs in 30d
Description
**Describe the bug**
Local tutorial on a fresh Mac doesn't work, it needs additional steps.
**Environment (please complete the following information):**
- Operating System and Version: macOS 10.15.7 (Catalina)
- Hardware: Macbook Pro 2015 / i7 2.6GHz / 32 GB RAM
**Additions & corrections to the tutorial**
* before calling `brew cask install docker-edge` the following was required, otherwise brew couldn't find this cask:
`brew tap homebrew/cask-versions`
* when you first run the Docker.app you need to check "Enable Kubernetes" in the Kubernetes tab, and "Apply & Restart".
* "visiting the Kubernetes dashboard" - for a Kubernetes newbie this is totally cryptic, it should probably direct the user to the later section on installing the dashboard.
* "Create a collection" section should probably add `?commit=true` when indexing new docs to make them immediately visible for searching. For Solr newbies it may be confusing that search will still return 0 docs for a while.
* following the example "scaling up" section, adding more (docker) replicas resulted in some instability - occasionally instead of 5 it would show 4 nodes, and the `kubectl proxy` would show:
`http: proxy error: context canceled`
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the local tutorial and following it on macOS with Docker and Kubernetes enabled. Check each reported step, including Homebrew setup, dashboard guidance, document indexing, and scaling; done means the tutorial is corrected and the replica/proxy behavior is either resolved or clearly documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, kubernetes, macos
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100