crossplane / crossplane/docs

Inconsistent naming recommendation for XRD kind

Open
#1,056 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
SCSS
Stars
60
Forks
163
Avg merge
15h 20m
Merged PRs (30d)
9

Description

### URL
https://docs.crossplane.io/latest/composition/composite-resource-definitions/#xrd-names

### What's Wrong?

In Crossplane v2 there are no more claims, so there's no longer a need to add an "X" prefix to differentiate claims from XRs. The v2 docs were updated to reflect this in 66ca4102982e7e6dda91596ae0c114de326b104b etc., but the XRD page still documents the old naming recommendation, and also does so in an inconsistent manner.

Specifically, this needs to be updated:
https://github.com/crossplane/docs/blob/15fb38a6c4fe6f8b5f6094372f2ff64d4ef3d2d0/content/v2.1/composition/composite-resource-definitions.md?plain=1#L120-L123

As well as examples throughout the page.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.