DependencyTrack / DependencyTrack/dependency-track

Include version info in default configuration documentation

Open
#283 0 comments 0 reactions 0 assignees View on GitHub
enhancement p3
Dominant language
Java
Stars
4.2k
Forks
811
Avg merge
8h 39m
Merged PRs (30d)
237

Description

This is a suggestion for a tweak to the documentation of "Default Configuration" that is provided on the Getting Started - > [Configuration](https://docs.dependencytrack.org/getting-started/configuration/) page.

It would be helpful if the documentation of default configuration were to explicitly state a version number for new properties. ie, something like "Added in 3.4.0".

This would make it easier to audit configuration prior to an upgrade in order to check that deployed configuration is not missing anything.

Contributor guide

Open the contributing guide

Research direction

Start with the Default Configuration section at https://docs.dependencytrack.org/getting-started/configuration/. Locate its documentation source and verify introduction versions for the properties being documented; the issue names no source files or specific properties. Done means readers can identify newly introduced configuration properties by explicit version annotations. With no replies in over seven years, confirm the scope is still wanted before starting.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
46/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.