Document `konveyor.io` namespace labels and best practices
Open
kind/documentation
needs-priority
stale
team/insights-discovery
triage/needs-information
- Dominant language
- Java
- Stars
- 6
- Forks
- 49
- PR merge metrics
- No merged PRs in 30d
Description
There are `konveyor.io` labels used across the default rulesets for source/target usage within the project. These labels need to be clearly documented for their purpose and we should advocate that custom rules authors do not use these labels to avoid confusion with some of the workflows we have in the current user experience.
Contributor guide
Research direction
Start by reviewing the default rulesets and locating the existing `konveyor.io` labels and the workflows that use them. Document each label's purpose and explain why custom rules authors should avoid the namespace; done means the guidance covers source/target usage and the relevant user-experience confusion.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 56/100