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.

Sign up for GitHub

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

Jump to bottom

📖 Link architecture and code walkthrough videos in docs #4427

Merged
merged 1 commit into from
Apr 14, 2021
Merged

📖 Link architecture and code walkthrough videos in docs #4427

merged 1 commit into from
Apr 14, 2021
+12 −0

Conversation

mrajashree
Copy link
Contributor

What this PR does / why we need it: This PR adds links to some of the videos available online that explain cluster api architecture or include code walkthrough of some components.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 2, 2021
@k8s-ci-robot
Copy link
Contributor

Welcome @mrajashree!

It looks like this is your first PR to kubernetes-sigs/cluster-api 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @mrajashree. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 2, 2021
@CecileRobertMichon
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Apr 2, 2021
CecileRobertMichon
CecileRobertMichon reviewed Apr 5, 2021
View reviewed changes
docs/book/src/developer/guide.md Outdated
## Videos explaining CAPI architecture and code walkthrough

- CAPI components and architecture
- https://youtu.be/npFO5Fixqcc
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- https://youtu.be/npFO5Fixqcc
- [Cluster API Deep Dive](https://youtu.be/npFO5Fixqcc)

Consider formatting the links with the title of the video so it's easier to know which one is which when we add more to the list in the future

Copy link
Member

Choose a reason for hiding this comment

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

Let's also maybe add the year and target version to these?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@vincepri I added in the year and month of the videos, kind of hard to tell the target version from the videos though. is year/month enough? For the CAPD walkthrough I've added v1alpha4

Copy link
Contributor

Choose a reason for hiding this comment

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

should we include other kubecon videos as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure, I tried adding only the latest videos, but if there's any other specific videos you want to add let me know 👍

Copy link
Contributor

Choose a reason for hiding this comment

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

I could find these

https://www.youtube.com/watch?v=AeHfVFepsMg
https://www.youtube.com/watch?v=9SfuQQeeK6Q
https://www.youtube.com/watch?v=B_Zb9_Ralb4

Also, including the latest makes sense. I'll let others chime in on whether to add these or now.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok thanks, the second one's already in the PR, I can add in the remaining two

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ashish-amarnath the first video is v1alpha3 version right? and what about the third?

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 8, 2021
@mrajashree mrajashree force-pushed the docs branch 4 times, most recently from 5e6d786 to 055222c Compare April 8, 2021 19:33
@mrajashree
Copy link
Contributor Author

not sure why the indentation is a bit off in the diff, if I click on "view file" it shows the right indentation.

sbueringer
sbueringer reviewed Apr 8, 2021
View reviewed changes
docs/book/src/developer/guide.md Outdated

- CAPI components and architecture

- [Cluster API Deep Dive - Dec 2020](https://youtu.be/npFO5Fixqcc)
Copy link
Member

Choose a reason for hiding this comment

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

I think there's a tab vs. spaces problem :) (same in l.235)

@sbueringer
Copy link
Member

sbueringer commented Apr 8, 2021 •
edited
Loading

not sure why the indentation is a bit off in the diff, if I click on "view file" it shows the right indentation.

one tab vs 2 spaces :) (you can also see it in the raw view)

@mrajashree mrajashree requested a review from sbueringer April 8, 2021 20:24
@sbueringer
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 8, 2021
@fabriziopandini
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 12, 2021
@fabriziopandini
Copy link
Member

/retest

@sbueringer
Copy link
Member

/retest
we have to many flakes :)

@ashish-amarnath
Copy link
Contributor

/retest

@CecileRobertMichon
Copy link
Contributor

/retest

related to #4466

@sbueringer
Copy link
Member

/retest

All unrelated flakes, as in this PR only doc was changed. Shouldn't need a lot more retries after #4466 has been merged

@k8s-ci-robot k8s-ci-robot merged commit 768695b into kubernetes-sigs:master Apr 14, 2021
@k8s-ci-robot k8s-ci-robot added this to the v0.4 milestone Apr 14, 2021
@mrajashree mrajashree mentioned this pull request Jul 15, 2021
Closed
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JoelSpeed JoelSpeed Awaiting requested review from JoelSpeed

@moshloop moshloop Awaiting requested review from moshloop

@vincepri vincepri Awaiting requested review from vincepri

@CecileRobertMichon CecileRobertMichon Awaiting requested review from CecileRobertMichon

@sbueringer sbueringer Awaiting requested review from sbueringer

@ashish-amarnath ashish-amarnath Awaiting requested review from ashish-amarnath

Assignees

@sbueringer sbueringer

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
v0.4
Development

Successfully merging this pull request may close these issues.
7 participants
@mrajashree @k8s-ci-robot @CecileRobertMichon @sbueringer @fabriziopandini @ashish-amarnath @vincepri