hashicorp / hashicorp/nomad

Document deprecated Resources fields

Open
#9,078 0 comments 0 reactions 0 assignees View on GitHub
theme/api theme/docs
Dominant language
Go
Stars
17k
Forks
2.1k
Avg merge
1d 9h
Merged PRs (30d)
105

Description

## Issue

Nomad deprecated various Node and Allocation Resources fields around v0.9. Since our API docs lack per-response-field level of detail, the deprecations have gone undocumented outside of code.

- Alloc fields: https://github.com/hashicorp/nomad/blob/v0.12.5/nomad/structs/structs.go#L8538-L8555
- Node fields: https://github.com/hashicorp/nomad/blob/v0.12.5/nomad/structs/structs.go#L1745-L1748

## Resolution 1: Upgrade guide

Dig into git and retcon the upgrade specific guide to mention these deprecations: https://www.nomadproject.io/docs/upgrade/upgrade-specific

## Resolution 2: Document response fields in API docs

Ideally our API docs would include per-response-field information, but this is a large effort and should not block more immediate solutions to the deprecation issue.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the deprecated Allocation and Node Resources fields in nomad/structs/structs.go at the linked ranges, then review the git history for their deprecation context. Update docs/upgrade/upgrade-specific with the relevant deprecations and verify that the guide clearly identifies the affected fields and versions.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.