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

Topology Manager docs update for 1.19 #21607

Conversation

klueska
Copy link
Contributor

@klueska klueska commented Jun 9, 2020

Signed-off-by: Kevin Klues kklues@nvidia.com

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 9, 2020
@k8sio-netlify-preview-bot
Copy link
Collaborator

k8sio-netlify-preview-bot commented Jun 9, 2020

Deploy preview for kubernetes-io-vnext-staging processing.

Building with commit 7b270b4

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/5f0c75caa7f90c0007719e0a

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 9, 2020
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Jun 9, 2020
@savitharaghunathan
Copy link
Member

/milestone 1.19
/assign

@k8s-ci-robot k8s-ci-robot added this to the 1.19 milestone Jun 10, 2020
@klueska klueska force-pushed the upstream-topology-manager-docs-update branch 2 times, most recently from b21a40b to 2af48ec Compare July 6, 2020 11:05
@klueska klueska changed the title [WIP] Topology Manager docs update for 1.19 Topology Manager docs update for 1.19 Jul 6, 2020
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 6, 2020
@annajung
Copy link
Contributor

Hi @klueska, docs shadow here 👋 just a friendly reminder this PR needs tech and doc review by July 16th.

Copy link

@nolancon nolancon left a comment

Choose a reason for hiding this comment

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

One small nit. LGTM otherwise.

@klueska klueska force-pushed the upstream-topology-manager-docs-update branch from 2af48ec to 6fbd89d Compare July 13, 2020 11:15
@nolancon
Copy link

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 13, 2020
@klueska
Copy link
Contributor Author

klueska commented Jul 13, 2020

@annajung, @nolancon has provided the necessary tech review and added his LGTM. Who do I need to ping for the doc review?

@annajung
Copy link
Contributor

Hi @klueska, you can reach out to docs team at #sig-docs channel to request a review, please let me know if you need any help

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Hi @klueska

Here's some feedback.

  1. I recommend using a note shortcode (see inline suggestion)
  2. Does https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/ require any changes as part of this PR?

Comment on lines 124 to 130
**Note:** Plugins are not required to provide useful implementations for
`GetPreferredAllocation()` or `PreStartContainer()`. Flags indicating which
(if any) of these calls are available should be set in the `DevicePluginOptions`
message sent back by a call to `GetDevicePluginOptions()`. The `kubelet` will
always call `GetDevicePluginOptions()` to see which optional functions are
available, before calling any of them directly.
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
**Note:** Plugins are not required to provide useful implementations for
`GetPreferredAllocation()` or `PreStartContainer()`. Flags indicating which
(if any) of these calls are available should be set in the `DevicePluginOptions`
message sent back by a call to `GetDevicePluginOptions()`. The `kubelet` will
always call `GetDevicePluginOptions()` to see which optional functions are
available, before calling any of them directly.
{{% note %}}
Plugins are not required to provide useful implementations for
`GetPreferredAllocation()` or `PreStartContainer()`. Flags indicating which
(if any) of these calls are available should be set in the `DevicePluginOptions`
message sent back by a call to `GetDevicePluginOptions()`. The kubelet
always calls `GetDevicePluginOptions()` to see which optional functions are
available, before calling any of them directly.
{{% /note %}}

Use a Note shortcode (untested).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  1. Updated per your suggestion with 1 minor difference. I used {{< note >}} not {{% note %}} as the link you provided suggested.
  2. No, this actually moved to beta in 1.18, but the documentation was never updated to reflect that. The feature gate was toggled to "always-on" back before 1.18 was released.

Copy link
Contributor

Choose a reason for hiding this comment

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

On detail 1, I did also file #22488 about the advice being not quite right for callout shortcodes. Anyway, it renders well enough as is.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Signed-off-by: Kevin Klues <kklues@nvidia.com>
@klueska klueska force-pushed the upstream-topology-manager-docs-update branch from 6fbd89d to 7b270b4 Compare July 13, 2020 14:55
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 13, 2020
Copy link

@vpickard vpickard left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for updating the docs.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 13, 2020
@klueska
Copy link
Contributor Author

klueska commented Jul 14, 2020

Hello, @kubernetes/sig-docs-en-owners

I am looking for an approval on this PR. It's already got a LGTM from a technical perspective.

@irvifa
Copy link
Member

irvifa commented Jul 14, 2020

/approve

Copy link
Member

@savitharaghunathan savitharaghunathan left a comment

Choose a reason for hiding this comment

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

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: irvifa, savitharaghunathan

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 Jul 14, 2020
@k8s-ci-robot k8s-ci-robot merged commit 713603e into kubernetes:dev-1.19 Jul 14, 2020
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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants