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

Docs: update syncer.md to make the syncer dev steps a bit clear for the local kcp kind-based syncer scenario. #2347

Merged
merged 5 commits into from
Nov 23, 2022

Conversation

merlante
Copy link
Contributor

@merlante merlante commented Nov 11, 2022

Summary

Make the syncer dev steps a bit clear for the local kcp kind-based syncer scenario.

Related issue(s)

No related issue

Make the syncer dev steps a bit clear for the local kcp kind-based syncer scenario.
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Nov 11, 2022

Hi @merlante. Thanks for your PR.

I'm waiting for a kcp-dev member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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/test-infra repository.

@openshift-ci openshift-ci bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Nov 11, 2022
@merlante merlante changed the title Update syncer.md to make the syncer dev steps a bit clear for the local kcp kind-based syncer scenario. Docs: update syncer.md to make the syncer dev steps a bit clear for the local kcp kind-based syncer scenario. Nov 14, 2022
@davidfestal davidfestal self-assigned this Nov 16, 2022
Copy link
Member

@davidfestal davidfestal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice. Just did some small comments.

docs/content/en/main/concepts/syncer.md Outdated Show resolved Hide resolved
docs/content/en/main/concepts/syncer.md Outdated Show resolved Hide resolved
1. Create an organisation and immediately enter it:

```sh
$ kubectl kcp workspace ..
$ kubectl kcp workspace create my-org --enter
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$ kubectl kcp workspace create my-org --enter
$ kubectl kcp workspace create my-workloads --enter

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have applied this change. The only issue is that "my-org" is used elsewhere on this page, and it is termed an organisation (as opposed to a second workspace as you have advised) in those sections. I decided to leave "my-org" in the steps in those other sections because a) those sections do not (yet) use the 2 workspace (locations/workloads) setup, so it might be confusing to see "my-locations" without reference to a "my-workloads" and b) I didn't really want to change those steps without testing them and ensuring I wasn't breaking something.

Anyway, let me know if you are happy to go with the suggested changes or whether you think it would be better to wait for the references to "my-org" to be removed and the 2 workspace format put in in all sections in the same PR. (My preference is just to go ahead and come back to it again later.)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My preference is just to go ahead and come back to it again later

I agree with that as well.

@ncdc ncdc added the area/transparent-multi-cluster Related to scheduling of workloads into pclusters. label Nov 17, 2022
@merlante
Copy link
Contributor Author

@davidfestal I think this PR is ready unless you want to consider what I said in my last comment.

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 23, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Nov 23, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: davidfestal

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

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 23, 2022
@openshift-merge-robot openshift-merge-robot merged commit fb2d022 into kcp-dev:main Nov 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/transparent-multi-cluster Related to scheduling of workloads into pclusters. lgtm Indicates that a PR is ready to be merged. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants