hashicorp / hashicorp/packer-plugin-azure

Missing vital piece of information on the documentation

Open
#102 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Go
Stars
63
Forks
103
PR merge metrics
No merged PRs in 30d

Description

#### Overview of the Issue

In the documentation of the DTL builder, the description of the object DtlArtifact has a missing member, repository_name, which requires to have the private repository name.

#### Reproduction Steps

1. Go to https://www.packer.io/docs/builders/azure/dtl#dtlartifact
2. Notice there is only reference to artifact_name, artifact_id, parameters

As the repository_name is set to "public artifacts" in case that is not specified in the config file, the documentation states nothing about that member being available, and azure only says something along the lines "The ResourceId for the artifact is malformed"... it is very easy to spend a lot of time debugging this issue.

Contributor guide

Open the contributing guide

Research direction

Start with the DTL builder documentation at the linked Azure page and inspect the DtlArtifact section, which currently lists artifact_name, artifact_id, and parameters. Document repository_name, including its private repository purpose and the default of "public artifacts" when omitted, then verify the rendered section reflects the available configuration member.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.