saltstack/salt

[BUG] Improve and reference Changelog docs in PR docs

Open

#59,854 opened on Mar 20, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (13,710 stars) (5,508 forks)batch import
bugdoc-requestdocumentationgood first issuehelp-wantedseverity-lowtime-estimate-sprint

Description

We have Changelog documentation here:

https://docs.saltproject.io/en/latest/topics/development/changelog.html

However, this documentation is not integrated or referenced in our documentation on how to create PRs:

https://docs.saltproject.io/en/latest/topics/development/contributing.html

The "Changelog" section appears BEFORE the Contributing section, but should likely be placed INSIDE the Contributing section. It is a key part of our PR process, and we have several community contributors who write their own Changelog entries.

Thus, it should be integrated into the steps listed in contributing.html.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The task involves updating the contributing.html documentation to include the changelog section from changelog.html. The issue suggests moving the changelog section inside the contributing section. The contributor should review both files (links provided in the issue) and restructure the documentation accordingly. No maintainer response needed.