prometheus / prometheus/docs

content duplication: Getting Started and First Steps

Open
#3,066 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue kind/enhancement
Dominant language
TypeScript
Stars
717
Forks
1.2k
Avg merge
3d 15h
Merged PRs (30d)
19

Description

The content in tutorials/getting_started and introduction/first_steps heavily overlaps.
Perhaps merge the hands-on PromQL walkthrough from first_steps into the existing tutorial. Delete first_steps.
Add redirect.

edit: I misfiled this, we should unify the content in introduction/first_steps and remove tutorials/getting_started. Apologies for the confusion.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare tutorials/getting_started and introduction/first_steps, beginning with the PromQL walkthrough and the overlapping sections. Unify the content in introduction/first_steps, remove tutorials/getting_started, and add a redirect from the removed tutorial path. Done means the unified page preserves the useful material and the old path redirects correctly.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.