-
Notifications
You must be signed in to change notification settings - Fork 871
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
[Umbrella] Update the karmada repository documentation #5484
Comments
/help |
@zhzhuang-zju: Please ensure the request meets the requirements listed here. If this request no longer meets these requirements, the label can be removed In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
@a7i Could you please guide me on how to get the created time in charts/index.yaml? thanks~ Line 6 in e579560
|
are you working on task if you haven't start it, you can assign it to me I was just about to do this. |
sure, very welcome~ |
I remember we could refer to this: #4051 (comment) |
thanks~ I'll update it in the task description |
Just add a link to https://github.com/karmada-io/karmada/tree/master/docs/CHANGELOG would be ok. |
good idea~ I have update it in the task description |
Yeah, you're right. However, updating file kubernetes-compatibility is relatively difficult and might not be appropriate for a |
I would like to work on this issue |
@Nishant-k-sagar welcome~, which task are you interested in? |
Task description:
Karmada released the latest version
release-1.11
on August 31, 2024. With the release of the new version, some of the documentation in the Karmada repository is now outdated and needs to be updated.We have stopped updating images for release-1.8 and added release-1.11 in #5504, and the
karmada-version
in [ci-schedule-compatibility.yaml] (https://github.com/karmada-io/karmada/blob/master/.github/workflows/ci-schedule-compatibility.yaml) should be updatedThe sample file specifies the image tags for various Karmada components, as well as for etcd and kube-apiserver. While dynamic configuration is desired, manual updates are still necessary until a solution is implemented. Currently, the image tags for Karmada components in the sample file are
v1.8.0
and need to be upgraded tov1.11.0
.Currently, the CHANGELOGS.md file displays links to the changelogs for various versions. It is incomplete and also difficult to maintain. Just add a link to https://github.com/karmada-io/karmada/tree/master/docs/CHANGELOG would be ok. just like
Trivy is used in both ci image-scanning and hack/scan-image-vuln.sh. The version of Trivy used in the CI action is
v0.53.0
. To provide a consistent experience for image-scanning both locally and in the GitHub CI, the version of Trivy used in scan-image-vuln.sh is being upgraded fromv0.48.1
tov0.53.0
.The file charts/index.yaml records the version information for the karmada chart. Currently, the latest chart version recorded in charts/index.yaml is
karmada-chart-v1.9.0.tgz
. It is necessary to addkarmada-chart-v1.10.0.tgz
and update the latest version tokarmada-chart-v1.11.0.tgz
.Ways to obtain key information:
created: refer to #4051 (comment)
digest: https://github.com/karmada-io/karmada/releases/download/v1.11.0/karmada-chart-v1.xxx.xxx.tgz.sha256
d4d9bbbda5ac03a4ba9349b17973b3df9047849398735dcb36cec4ec39140046 # the digest of the chart hack/../_output/charts/karmada-chart-v1.11.0.tgz
PRs for reference: #4671
Who can join or take the task:
The good first issue is intended for
first-time contributors
to get started on his/her contributor journey.After a contributor has successfully completed 1-2 good first issue's,
they should be ready to move on to
help wanted
items, saving the remaininggood first issue
for other new contributors.How to join or take the task:
Just reply on the issue with the message
/assign
in a separate line.Then, the issue will be assigned to you.
How to ask for help:
If you need help or have questions, please feel free to ask on this issue.
The issue author or other members of the community will guide you through the contribution process.
The text was updated successfully, but these errors were encountered: