Make modifications in the flowchart diagram at "Extending Kubernetes" section to tackle incorrect wording #43109

ArvindParekh · 2023-09-19T12:47:37Z

Problem Description:

The Extension point choice flowchart at link contains a grammatical error and mentions a section which is not present in the docs (i.e. the "Adding APIs" section)

Changes Made:

Re-created the flowchart to include the correct section (i.e. the "API Extensions" section)
Increased the font size to make it more readable.

Fixes #43050

Screenshots:

Before:

After:

linux-foundation-easycla · 2023-09-19T12:47:42Z

The committers listed above are authorized under a signed CLA.

✅ login: ArvindParekh / name: Arvind (80bf6dd, b8d94a4)

k8s-ci-robot · 2023-09-19T12:47:45Z

Welcome @ArvindParekh!

It looks like this is your first PR to kubernetes/website 🎉. 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/website 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. 😃

ArvindParekh · 2023-09-19T12:54:00Z

/easycla

netlify · 2023-09-19T13:02:36Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`b8d94a4`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/65129b36700d93000802c163
😎 Deploy Preview	https://deploy-preview-43109--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Gauravpadam

I like the idea of white text in the flowchart, It's more readable now
I like how you've eliminated the negative space from the image, The image looks better now

Overall, lgtm

sftim · 2023-09-20T15:58:30Z

content/en/docs/concepts/extend-kubernetes/flowchart.png

Please don't use a lower resolution chart. You can keep the same raster height and width, or you can switch it to SVG

If changing colors, please consider using Kubernetes colors

Thanks, Tim.

Oh yes, it slipped my mind, I'll go with the SVG

I thought I only had to make the textual correction in this one and then a second PR for the color changes, based on our discussion in Wrong wording in diagram at https://k8s.io/docs/concepts/extend-kubernetes/ #43050

But I guess it'll be easier to do both in the same PR, this is the updated diagram with Kubernetes colors (Kubernetes blue-> #326CE6, Kubernetes orange-> #D95E08, Kubernetes green -> #4CAF50 and Kubernetes gray -> #333333) that I'll be using in my next commit.
Please have a look and let me know in case of any changes:

You can leave the colors as-is. Right now this PR is making color changes - to some of the text. I'm fine with either no styling changes at all, or recoloring to match our house styles better.

If recoloring, I would make the rhombus shapes white text on blue, with no stroke color, and use gray (again, no stroke color) for the YES / NO ellipses.

To help with accessibility, consider making the YES and NO text larger and also bold

Got it!

I've made the suggested changes and used #326CE6 for blue and well, experimented with different shades - #333333, #454545 and #7E7E7E, for gray.
[Some googling suggested me #333333 as the widely used gray in and around Kubernetes, but it closely resembles black, so I thought of comparing it with slightly lighter shades; which reminds me, maybe a dedicated section in the style guide of the docs mentioning the Kubernetes color codes?]

Also increased the font size from 16 to 18 for better visibility and made the text bold for YES and NO ellipses.

Here's how the website looks using the following shades of gray:

#333333

#454545

#7E7E7E

(Excuse me, if the website screenshots look purple-ish, there might be some issue with my computer)

I personally like the 2nd and 3rd ones, but please let me know which one you'd like me to go with or if there are any changes!

Let's go with #454545 gray, it's better for accessibility.

Alright, great!

sftim · 2023-09-23T11:51:24Z

content/en/docs/concepts/extend-kubernetes/_index.md

- erictune
- lavalamp
- cheftako
- chenopis
+ - erictune
+ - lavalamp
+ - cheftako
+ - chenopis


If you can leave these lines unchanged, even better.

sftim · 2023-09-23T11:51:29Z

content/en/docs/concepts/extend-kubernetes/_index.md

-*Configuration files* and *command arguments* are documented in the [Reference](/docs/reference/) section of the online
+_Configuration files_ and _command arguments_ are documented in the [Reference](/docs/reference/) section of the online
 documentation, with a page for each binary:

-* [`kube-apiserver`](/docs/reference/command-line-tools-reference/kube-apiserver/)
-* [`kube-controller-manager`](/docs/reference/command-line-tools-reference/kube-controller-manager/)
-* [`kube-scheduler`](/docs/reference/command-line-tools-reference/kube-scheduler/)
-* [`kubelet`](/docs/reference/command-line-tools-reference/kubelet/)
-* [`kube-proxy`](/docs/reference/command-line-tools-reference/kube-proxy/)
+- [`kube-apiserver`](/docs/reference/command-line-tools-reference/kube-apiserver/)
+- [`kube-controller-manager`](/docs/reference/command-line-tools-reference/kube-controller-manager/)
+- [`kube-scheduler`](/docs/reference/command-line-tools-reference/kube-scheduler/)
+- [`kubelet`](/docs/reference/command-line-tools-reference/kubelet/)
+- [`kube-proxy`](/docs/reference/command-line-tools-reference/kube-proxy/)


If you can leave these lines unchanged, even better.

sftim · 2023-09-23T11:51:34Z

content/en/docs/concepts/extend-kubernetes/_index.md

-Built-in *policy APIs*, such as [ResourceQuota](/docs/concepts/policy/resource-quotas/),
+Built-in _policy APIs_, such as [ResourceQuota](/docs/concepts/policy/resource-quotas/),
 [NetworkPolicy](/docs/concepts/services-networking/network-policies/) and Role-based Access Control
 ([RBAC](/docs/reference/access-authn-authz/rbac/)), are built-in Kubernetes APIs that provide declaratively configured policy settings.
 APIs are typically usable even with hosted Kubernetes services and with managed Kubernetes installations.
 The built-in policy APIs follow the same conventions as other Kubernetes resources such as Pods.
 When you use a policy APIs that is [stable](/docs/reference/using-api/#api-versioning), you benefit from a
 [defined support policy](/docs/reference/using-api/deprecation-policy/) like other Kubernetes APIs.
-For these reasons, policy APIs are recommended over *configuration files* and *command arguments* where suitable.
+For these reasons, policy APIs are recommended over _configuration files_ and _command arguments_ where suitable.


If you can leave these lines unchanged, even better.

sftim · 2023-09-23T11:52:04Z

content/en/docs/concepts/extend-kubernetes/_index.md

The image changes are good, but: please watch out for your text editor making unrelated changes to the Markdown source.

Thanks, Tim.
I agree, there's some issue that's automatically making these unwanted changes in the markdown file and I didn't even realise these changes were made until after I pushed my branch, and I can't really figure out what it is. I've tried editing the file in Vim as well as Nano, but the issue's still there. I've explained it in depth in the slack's #sig-docs channel, to try and get some help.
I'd appreciate any help with this matter!

@ArvindParekh In your video shared on sig-docs, just noticed that you've installed the "Prettier" VS Code extension in the lower right corner. It's possible that it's configured to automatically format on save, which could be leading to unintended alterations. You could try uninstalling or disabling it to see if that resolves the issue.

@dipesh-rawat Thank you for the suggestion, it worked! Prettier was causing issues with the markdown file.
I've updated the file and pushed the changes.

sftim · 2023-09-23T11:52:15Z

content/en/docs/concepts/extend-kubernetes/flowchart.svg

tengqm · 2023-09-26T09:02:27Z

/lgtm
Changing png to svg is a good move.

k8s-ci-robot · 2023-09-26T09:02:36Z

LGTM label has been added.

Git tree hash: e9e2c39422ca94253621ed6a13cc1199fdf09d10

sftim

/approve

k8s-ci-robot · 2023-09-26T10:06:45Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Gauravpadam, sftim

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:

~~content/en/OWNERS~~ [sftim]

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 added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 19, 2023

k8s-ci-robot requested review from dipesh-rawat and shannonxtreme September 19, 2023 12:47

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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Sep 19, 2023

Gauravpadam approved these changes Sep 19, 2023

View reviewed changes

sftim reviewed Sep 20, 2023

View reviewed changes

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 22, 2023

ArvindParekh force-pushed the change-flowchart branch from 254ea46 to 9ffc2cd Compare September 22, 2023 14:28

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 22, 2023

ArvindParekh force-pushed the change-flowchart branch from 9ffc2cd to bf83c96 Compare September 22, 2023 16:34

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 22, 2023

sftim reviewed Sep 23, 2023

View reviewed changes

ArvindParekh added 2 commits September 26, 2023 14:13

change flowchart diagram to incorporate correct wording

80bf6dd

update flowchart diagram colors to kubernetes colors and format to svg

b8d94a4

ArvindParekh force-pushed the change-flowchart branch from bf83c96 to b8d94a4 Compare September 26, 2023 08:49

k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 26, 2023

k8s-ci-robot assigned tengqm Sep 26, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 26, 2023

sftim reviewed Sep 26, 2023

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 26, 2023

k8s-ci-robot merged commit 90359a6 into kubernetes:main Sep 26, 2023
6 checks passed

ArvindParekh mentioned this pull request Sep 3, 2024

REQUEST: New membership for ArvindParekh kubernetes/org#5127

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make modifications in the flowchart diagram at "Extending Kubernetes" section to tackle incorrect wording #43109

Make modifications in the flowchart diagram at "Extending Kubernetes" section to tackle incorrect wording #43109

ArvindParekh commented Sep 19, 2023

linux-foundation-easycla bot commented Sep 19, 2023 •

edited

Loading

k8s-ci-robot commented Sep 19, 2023

ArvindParekh commented Sep 19, 2023

netlify bot commented Sep 19, 2023 •

edited

Loading

Gauravpadam left a comment

sftim Sep 20, 2023

ArvindParekh Sep 21, 2023

sftim Sep 21, 2023

ArvindParekh Sep 22, 2023

sftim Sep 22, 2023

ArvindParekh Sep 22, 2023

sftim Sep 23, 2023

sftim Sep 23, 2023

sftim Sep 23, 2023

sftim Sep 23, 2023

ArvindParekh Sep 23, 2023

dipesh-rawat Sep 23, 2023

ArvindParekh Sep 26, 2023

sftim Sep 23, 2023

tengqm commented Sep 26, 2023

k8s-ci-robot commented Sep 26, 2023

sftim left a comment

k8s-ci-robot commented Sep 26, 2023

Make modifications in the flowchart diagram at "Extending Kubernetes" section to tackle incorrect wording #43109

Make modifications in the flowchart diagram at "Extending Kubernetes" section to tackle incorrect wording #43109

Conversation

ArvindParekh commented Sep 19, 2023

linux-foundation-easycla bot commented Sep 19, 2023 • edited Loading

k8s-ci-robot commented Sep 19, 2023

ArvindParekh commented Sep 19, 2023

netlify bot commented Sep 19, 2023 • edited Loading

✅ Pull request preview available for checking

Gauravpadam left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tengqm commented Sep 26, 2023

k8s-ci-robot commented Sep 26, 2023

sftim left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Sep 26, 2023

linux-foundation-easycla bot commented Sep 19, 2023 •

edited

Loading

netlify bot commented Sep 19, 2023 •

edited

Loading