Change docs to reference FQN for Kuadrant CRs (e.g. dnsrecords.kuadrant.io)
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- kubernetes
- Domain
- documentation
Research direction
No specific files or tests are named. Search the documentation for kubectl commands using short Kuadrant CR names, then update those references to fully qualified names such as dnsrecords.kuadrant.io; review scripts and make commands as a possible follow-up. Done means the documented commands use unambiguous FQNs, with any included script or make-command references updated consistently.
Written by the indexing model from the issue text.
Description
Change Kuadrant CR names everywhere in docs to Fully Qualified Names to avoid ambiguity (e.g. kubectl get dnsrecords -> kubectl get dnsrecords.kuadrant.io).
Also could be done for scripts and make commands for them to have broader usage availability
Example
# example command
kubectl get dnsrecords -A -o custom-columns="NAMESPACE:.metadata.namespace,NAME:.metadata.name,OWNER_ID:.status.ownerID,STATUS.GROUP:.status.group"
# change to
kubectl get dnsrecords.kuadrant.io -A -o custom-columns="NAMESPACE:.metadata.namespace,NAME:.metadata.name,OWNER_ID:.status.ownerID,STATUS.GROUP:.status.group"
- Dominant language
- Go
- Stars
- 12
- Forks
- 23
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 13
Contributor guide
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.
More from Kuadrant/dns-operator
-
Kuadrant/dns-operator#819 · 1 assignee ·
-
OLMv1
Difficulty 3/5 1-2 days Newbie friendliness 68/100
Kuadrant/dns-operator#804 ·
-
kind/feature
Kuadrant/dns-operator#776 · 1 assignee ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 35/100
Kuadrant/dns-operator#752 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
Kuadrant/dns-operator#749 ·
All issues in Kuadrant/dns-operator
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
enhancement needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
kind/cleanup
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
kubernetes-sigs/kueue#15947 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sympozium-ai/sympozium#627 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100