Inconsistent Key Naming for IACM workspace.yaml file between docs/code
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 25
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Description
The docs have a different naming scheme vs the code for the workspace.yaml file. the docs mention "org", "project", and "workspace", but the code uses "_id" on those names.
https://developer.harness.io/docs/infra-as-code-management/cli-commands/cli-iacm-plan/
from the code:
// WorkspaceInfo holds org, project and workspace identifiers from CLI or .harness/workspace.yaml
type WorkspaceInfo struct {
Org string `yaml:"org_id"`
Project string `yaml:"project_id"`
Workspace string `yaml:"workspace_id"`
}
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the workspace.yaml naming shown in the linked IACM CLI documentation with the WorkspaceInfo struct and its yaml tags in the Go code. Confirm the canonical keys with the surrounding implementation, then update the documentation so its org, project, and workspace names match the supported configuration; done when the docs and code consistently describe the same keys.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100