Repository navigation
docs: unify getting started content into first steps (#3066) - #3089
santhiprakash wants to merge 1 commit into
Conversation
- Problem: tutorials/getting_started and introduction/first_steps heavily overlap; jan--f (in prometheus#3066 and review on prometheus#3069) asked to keep intro → first steps as the single getting-started page. - Fix: fold the tutorial's unique node exporter hands-on walkthrough into first_steps' 'Monitoring other targets' section, point conceptual readers at the Overview, remove tutorials/getting_started (and its three now-unused tutorial images), and add a /docs/tutorials/getting_started/ → /docs/introduction/first_steps/ redirect. - Verification: make check (mdox fmt --check) passes; every link target in the rewritten section verified against the tree or existing generated routes (/download#node_exporter matches node-exporter.md:16). Signed-off-by: Santhi Prakash <b.santhiprakash@gmail.com>
|
@lasomethingsomething Good question — before renaming I checked what the page actually covers and what the other similarly-titled pages are, and there's a wrinkle worth surfacing. What's on this page: it's entirely the precompiled-binary path ( The wrinkle: jan--f's open #3110 already renames this exact file — nav title "Prometheus quickstart" at Given that, I've held off pushing "Binary setup" on this PR for two reasons:
Happy to do either: (a) push a title-only retitle in this PR now — |
|
@santhiprakash @jan--f I'm not sure the binary setup is the "quick" way, though? do you have any metrics/data around this from users (maybe it takes time upfront to save time later)? For me Docker was pretty quick. I'll try to get the binary setup to work and share my own impressions here w.r.t. "quick"... |
|
@lasomethingsomething Fair challenge. Honest answer on the metrics: none exist, as far as I can tell. OSS Prometheus ships no telemetry, and I couldn't find any published install-time data. The only public numbers are volume proxies, and they don't answer your question:
Both are dominated by CI/production traffic, so they show Docker is the dominant distribution channel — they say nothing about which path is quicker for a first-timer on a laptop. What I could measure myself (single datapoint, cloud VM, fast link — not a newcomer laptop): So I read your point the same way you framed it: whether binary deserves the "quickstart" slot is exactly the open "declare the recommended newcomer path" call in #3137, and the answer probably depends on the newcomer's starting state — which argues for the epic's two-clearly-labeled-paths direction rather than a single "quick" claim. (Also: this page reads long partly because it keeps going past install into Running the binary path yourself and reporting impressions is the best data available right now — curious what you hit, especially the Gatekeeper step. |
|
Thanks, I think it's best for this PR to be merged, then I'll set to work in a different issue/PR. |
|
@lasomethingsomething Sounds good — agreed. I'll leave this PR as-is (no rename), so nothing further is coming from my side here. Feel free to ping me on the follow-up issue if the binary-vs-Docker timing data would be useful there. |
Fixes #3066
Problem
tutorials/getting_startedandintroduction/first_stepsheavily overlap: both walk through downloading/configuring/running Prometheus. Per @jan--f's correction on #3069, the direction is now to unify the content inintroduction/first_stepsand removetutorials/getting_started.Triage / what changed
scrape_configsjob → query a host metric) intofirst_steps' existing "Monitoring other targets" section, keeping the deeper node exporter guide link.docs/tutorials/getting_started.mdand its three images, which nothing else referenced (architecture.png,sample_graph.png,node_exporter.pngunderpublic/assets/docs/tutorial/)./docs/tutorials/getting_started/ → /docs/introduction/first_steps/topublic/_redirects, matching the file's existing format.Verification
make check(mdox fmt--check) passes./download#node_exportermatches the existing pattern indocs/guides/node-exporter.md:16;overview,node-exporter, andexporterspages exist.grepconfirms no remaining references totutorials/getting_startedor the removed images anywhere in the repo.Notes
first_stepsif you'd like to keep them.prometheus/prometheus's docs directory, so it needs a cross-repo PR plus_redirectsupdates (lines 2 and 46 point at it today). Should I proceed with that after this one, or handle it separately?