chore(doc): rename package.yaml
to crossplane.yaml
#5835
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of your changes
Many months ago, I remember that in the initial design of
Configuration
to create a Crossplane package, it needs to put apackage.yaml
in the project folder.Now it seems not the case anymore, and I found that the page to describe
xpkg
seems not up-to-date to reflect the requirements of creating a Crossplane package.In this page it mentioned, to build a Crossplane package, it needs
crossplane.yaml
where the docs here says thepackage.yaml
is required.It causes some confusion, so this PR is trying to address this issue, and rename the
package.yaml
intocrossplane.yaml
.I have:
earthly +reviewable
to ensure this PR is ready for review.backport release-x.y
labels to auto-backport this PR.Need help with this checklist? See the cheat sheet.