docs: unify getting started content into first steps (#3066) - #3089
Open
santhiprakash wants to merge 1 commit into
Open
docs: unify getting started content into first steps (#3066)#3089santhiprakash wants to merge 1 commit into
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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?