Skip to content

Documentation for overlays (part 1) #708

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
Merged
merged 1 commit into from
Feb 12, 2021
Merged

Documentation for overlays (part 1) #708

merged 1 commit into from
Feb 12, 2021

Conversation

saikat-royc
Copy link
Member

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change
/kind bug
/kind cleanup
/kind design
/kind documentation
/kind failing-test
/kind feature
/kind flake

What this PR does / why we need it:
With new overlays introduced as part of #704 , this patch captures the related documentation for overlays.
The final update to the README.md will be done once we finish merging windows changes to appropriate stable-* overlays

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Documentation for overlays

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 11, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: saikat-royc

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 11, 2021
mattcary
mattcary reviewed Feb 11, 2021
View reviewed changes
Copy link
Contributor

@mattcary mattcary left a comment

Choose a reason for hiding this comment

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

A few minor nits, overall very complete and a great step forward from the current state of documentation!

annapendleton
annapendleton reviewed Feb 11, 2021
View reviewed changes
verult
verult reviewed Feb 12, 2021
View reviewed changes
Copy link
Contributor

@verult verult left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for the instructions doc!

As a note for the future, when we merge future overlay PRs, let's aim to add a link to the PR here under the corresponding example scenario

@saikat-royc saikat-royc force-pushed the overlays branch 3 times, most recently from c76f69e to 2eda251 Compare February 12, 2021 04:57
@saikat-royc
Copy link
Member Author

/retest

mattcary
mattcary reviewed Feb 12, 2021
View reviewed changes
@mattcary
Copy link
Contributor

/lgtm

doubtless there's more to tweak but it will probably be easier with smaller PRs

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 12, 2021
@k8s-ci-robot k8s-ci-robot merged commit 82ad74e into kubernetes-sigs:master Feb 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@verult verult verult left review comments

@annapendleton annapendleton annapendleton left review comments

@mattcary mattcary mattcary left review comments

Assignees

@mattcary mattcary

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. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@saikat-royc @k8s-ci-robot @mattcary @verult @annapendleton