karmada-io / karmada

Open, Multi-Cloud, Multi-Cluster Kubernetes Orchestration
https://karmada.io
Apache License 2.0
4.05k stars 790 forks source link

samples from documentation #3585

Closed bivas closed 9 months ago

bivas commented 10 months ago

What type of PR is this?

/kind documentation

What this PR does / why we need it: Adding the samples from documentation to repository

Does this PR introduce a user-facing change?:

NONE
karmada-bot commented 10 months ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: To complete the pull request process, please assign kevin-wangzefeng after the PR has been reviewed. You can assign the PR to them by writing /assign @kevin-wangzefeng in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/karmada-io/karmada/blob/master/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
XiShanYongYe-Chang commented 10 months ago

Hi, @bivas Welcome! :)

codecov-commenter commented 10 months ago

Codecov Report

Merging #3585 (b0d47b4) into master (218a0b2) will increase coverage by 0.02%. The diff coverage is n/a.

:exclamation: Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##           master    #3585      +/-   ##
==========================================
+ Coverage   55.86%   55.88%   +0.02%     
==========================================
  Files         216      216              
  Lines       20121    20121              
==========================================
+ Hits        11240    11245       +5     
+ Misses       8276     8272       -4     
+ Partials      605      604       -1     
Flag Coverage Δ
unittests 55.88% <ø> (+0.02%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

see 2 files with indirect coverage changes

bivas commented 10 months ago

@RainbowMango

Are these yamls come from https://github.com/karmada-io/website repo? Can you guys remind me why we need to do that?

Yes, these are the YAML from the website, with some minor alterations. I added them to avoid copy pasting from the docs. I don't think it's really required, but more of a nice to have.

RainbowMango commented 10 months ago

I added them to avoid copy pasting from the docs.

Sorry, I still can't get the benefit from it. Can you remind me?

My concern is we have a lot of yamls in the website repo, we don't need to maintain these yamls in two places I think.

bivas commented 10 months ago

@RainbowMango I agree. There shouldn't be multiple places for these YAMLs. It was just an easier way for me to try out several scenarios when going over the docs and though others might benefit from it as well.

Maybe the docs should only point to these YAMLs instead of embedding them? Again, I don't think it's that important, it's just to ease the evaluation process.

RainbowMango commented 10 months ago

Maybe the docs should only point to these YAMLs instead of embedding them?

I even feel that there is no need to maintain the links. Because the yamls in website repo might be changed over time, an extra effort is needed to maintain the link valid.
The example yamls in the website repo should support use in a copy-and-paste model. We can put our effort to this point.

RainbowMango commented 9 months ago

I'm going to close this for now, please feel free to reopen it if you want further discussions. /close

karmada-bot commented 9 months ago

@RainbowMango: Closed this PR.

In response to [this](https://github.com/karmada-io/karmada/pull/3585#issuecomment-1595578083): >I'm going to close this for now, please feel free to reopen it if you want further discussions. >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.