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

[Umbrella] Update the karmada repository documentation #5484

Open
1 of 5 tasks
zhzhuang-zju opened this issue Sep 5, 2024 · 13 comments
Open
1 of 5 tasks

[Umbrella] Update the karmada repository documentation #5484

zhzhuang-zju opened this issue Sep 5, 2024 · 13 comments
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

Comments

@zhzhuang-zju
Copy link
Contributor

zhzhuang-zju commented Sep 5, 2024

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 updated

The 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 to v1.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

# CHANGELOGs

[CHANGELOG](./docs/CHANGELOG/)

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 from v0.48.1 to v0.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 add karmada-chart-v1.10.0.tgz and update the latest version to karmada-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 remaining good 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.

@zhzhuang-zju zhzhuang-zju added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Sep 5, 2024
@zhzhuang-zju
Copy link
Contributor Author

/help

@karmada-bot
Copy link
Collaborator

@zhzhuang-zju:
This request has been marked as needing help from a contributor.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-help command.

In response to this:

/help

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.

@karmada-bot karmada-bot added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Sep 5, 2024
@zhzhuang-zju
Copy link
Contributor Author

@a7i Could you please guide me on how to get the created time in charts/index.yaml? thanks~

created: "2024-02-29T16:55:17.965911-05:00"

@chaosi-zju
Copy link
Member

chaosi-zju commented Sep 5, 2024

are you working on task update charts/index.yaml?

if you haven't start it, you can assign it to me

I was just about to do this.

@zhzhuang-zju
Copy link
Contributor Author

are you working on task update charts/index.yaml?

if you haven't start it, you can assign it to me

sure, very welcome~
And if it’s convenient for you, could you please guide me on how to obtain the created time? This would provide helpful instructions for future contributors.

@chaosi-zju
Copy link
Member

I remember we could refer to this: #4051 (comment)

@zhzhuang-zju
Copy link
Contributor Author

I remember we could refer to this: #4051 (comment)

thanks~ I'll update it in the task description

@RainbowMango
Copy link
Member

The CHANGELOGS.md only includes links to the changelogs from v0.9 to v1.1. We need to update it to v1.11. The modifications are as follows:

Just add a link to https://github.com/karmada-io/karmada/tree/master/docs/CHANGELOG would be ok.

@zhzhuang-zju
Copy link
Contributor Author

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

@liangyuanpeng
Copy link
Contributor

@zhzhuang-zju
Copy link
Contributor Author

https://github.com/karmada-io/karmada/tree/master?tab=readme-ov-file#kubernetes-compatibility need to update

Yeah, you're right. However, updating file kubernetes-compatibility is relatively difficult and might not be appropriate for a good first issue.

@Nishant-k-sagar
Copy link

I would like to work on this issue
/assign

@zhzhuang-zju
Copy link
Contributor Author

I would like to work on this issue

@Nishant-k-sagar welcome~, which task are you interested in?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Projects
None yet
Development

No branches or pull requests

6 participants