Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(doc): rename package.yaml to crossplane.yaml #5835

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

cychiang
Copy link
Contributor

@cychiang cychiang commented Jul 18, 2024

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 a package.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 the package.yaml is required.

It causes some confusion, so this PR is trying to address this issue, and rename the package.yaml into crossplane.yaml.

I have:

  • Read and followed Crossplane's contribution process.
  • Run earthly +reviewable to ensure this PR is ready for review.
  • Added or updated unit tests.
  • Added or updated e2e tests.
  • Linked a PR or a docs tracking issue to document this change.
  • Added backport release-x.y labels to auto-backport this PR.

Need help with this checklist? See the cheat sheet.

…latest terminology

Signed-off-by: Chuan-Yen Chiang <chuanyen.chiang@volvocars.com>
@cychiang cychiang requested review from negz and a team as code owners July 18, 2024 13:13
@cychiang cychiang requested a review from bobh66 July 18, 2024 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant