sourcegraph/sourcegraph-public-snapshot

Docs update to better integrate overlays info

Open

#19,428 opened on Mar 24, 2021

View on GitHubContributor guide
 (2 comments) (0 reactions) (1 assignee)Go (1,374 forks)auto 404
docsgood first issueteam/delivery

Repository metrics

Stars
 (10,290 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the issue

Right now our kubernetes install documentation (https://docs.sourcegraph.com/admin/install/kubernetes#steps) has a couple of things that have confused users:

  1. The steps are an unordered list, which seems confusing since they are sequential (but maybe there's context I'm missing)
  2. Right now, we don't link out to the overlays documentation or point out to users when what's in the install docs will diverge for those using overlays: "Deploy the desired version of Sourcegraph to your cluster: ./kubectl-apply-all.sh".

Where is the issue located?

https://docs.sourcegraph.com/admin/install/kubernetes#steps

Suggested resolution

Per the conversation at https://sourcegraph.slack.com/archives/CJX299FGE/p1616607364105000, I feel like at that step we should either link out to the overlay documentation (https://docs.sourcegraph.com/admin/install/kubernetes/configure#overlay-basic-principles) and clarify that that process stands in for the apply-all script.

Contributor guide

Research direction
Review the current Kubernetes install documentation at https://docs.sourcegraph.com/admin/install/kubernetes#steps, and add a link to the overlays documentation (https://docs.sourcegraph.com/admin/install/kubernetes/configure#overlay basic principles) at the step that mentions './kubectl apply all.sh'. Also consider changing the unordered list to an ordered list to indicate sequential steps.
Tech stack
kubernetes
Domain
devops
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80