Rewrite Configuring Redis using a ConfigMap #48716

jerry-li-dev · 2024-11-14T03:31:34Z

Description

Rewrote the following documents for clarity:

Configuring Redis using a ConfigMap
Prerequisites doc

Issue

Closes: #

Rewrote the following documents for clarity: - Configuring Redis using a ConfigMap - Prerequisites doc

linux-foundation-easycla · 2024-11-14T03:31:41Z

The committers listed above are authorized under a signed CLA.

✅ login: jerry-li-dev / name: Jerry Li (0a65f05, 0038e46, 6281790, f5f295d)

k8s-ci-robot · 2024-11-14T03:31:44Z

Welcome @jerry-li-dev!

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. 😃

k8s-ci-robot · 2024-11-14T03:31:46Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign divya-mohan0209 for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

content/en/OWNERS

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

jerry-li-dev · 2024-11-14T03:36:20Z

Restest please

T-Lakshmi · 2024-11-14T03:58:07Z

/retest

Fix grammar issue

T-Lakshmi · 2024-11-14T05:05:01Z

@jerry-li-dev,
Buid faild due to netlify error.

Can you try to force push the commit and see if error can fix.

T-Lakshmi · 2024-11-14T05:05:45Z

Below are the commands you need to execute to trigger the build again:

git reset
git commit --amend --no-edit
git push --force-with-lease

Fix grammar issue

…com/jerry-li-dev/website into rewrite-config-redis-with-configmap

jerry-li-dev · 2024-11-14T10:33:43Z

/retest

k8s-ci-robot · 2024-11-14T10:33:57Z

@jerry-li-dev: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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-sigs/prow repository.

jihoon-seo

We cannot retrigger Netlify builds with /ok-to-test Prow command.
Instead, you can use this method.

But the point is that the build error occurs because there exists an error in this PR.
Netlify build log is saying that:

Error: error building site: process: readAndProcessContent: "/opt/build/repo/content/en/includes/task-tutorial-prereqs.md:1:1": invalid YAML delimiter

jihoon-seo · 2024-11-18T07:26:39Z

content/en/includes/task-tutorial-prereqs.md

+- If you do not already have a cluster, you can create one by using [minikube](https://minikube.sigs.k8s.io/docs/tutorials/multi_node/) or you can use one of these Kubernetes playgrounds:
+    - [Killercoda](https://killercoda.com/playgrounds/scenario/kubernetes)
+    - [Play with Kubernetes](https://labs.play-with-k8s.com/)

-* [Killercoda](https://killercoda.com/playgrounds/scenario/kubernetes)
-* [Play with Kubernetes](https://labs.play-with-k8s.com/)
+* Understand how to [configure a Pod to use a ConfigMap](/docs/tasks/configure-pod-container/configure-pod-configmap/).


I suggest you to preserve the task-tutorial-prereqs.md as-is, not modifying in this PR.

The formatting in the current task tutorial file is not usable. It has to be changed.

Hi Jerry, you should clarify how it's not usable in your PR description and why the change is important.

Existing formatting seems fine to me, so an explanation of why you find it not usable would be helpful.

stmcginnis

Most of this is just rewording existing content without materially changing much. More details as to why you want to make these changes and what is wrong with the existing content would be good to add to the description.

stmcginnis · 2024-11-20T13:21:53Z

content/en/docs/tutorials/configuration/configure-redis-using-configmap.md


+## What you'll learn


Is there a reason for moving away from the conventional Objectives section heading?

stmcginnis · 2024-11-20T13:23:08Z

content/en/docs/tutorials/configuration/configure-redis-using-configmap.md


 * Create a ConfigMap with Redis configuration values
 * Create a Redis Pod that mounts and uses the created ConfigMap
 * Verify that the configuration was correctly applied.

+## Requirements


Here too, why move away from the standardized prerequisites block?

stmcginnis · 2024-11-20T13:24:12Z

content/en/docs/tutorials/configuration/configure-redis-using-configmap.md


+- Kubernetes cluster
+- kubectl command-line tool (`kubectl` 1.14 and above) configured to communicate with your cluster.


I think this statement is misleading. It implies you could use kubectl 1.14, but that is not correct for most users today. A specific version reference could probably be dropped here since 1.14 (and many more of the later ones) are well end of life by this point.

stmcginnis · 2024-11-20T13:25:37Z

content/en/docs/tutorials/configuration/configure-redis-using-configmap.md


 <!-- lessoncontent -->

+## 1. Create a Redis ConfigMap


I don't think we want to use bullet number is section headers.

stmcginnis · 2024-11-20T13:27:09Z

content/en/includes/task-tutorial-prereqs.md

+- If you do not already have a cluster, you can create one by using [minikube](https://minikube.sigs.k8s.io/docs/tutorials/multi_node/) or you can use one of these Kubernetes playgrounds:
+    - [Killercoda](https://killercoda.com/playgrounds/scenario/kubernetes)
+    - [Play with Kubernetes](https://labs.play-with-k8s.com/)

-* [Killercoda](https://killercoda.com/playgrounds/scenario/kubernetes)
-* [Play with Kubernetes](https://labs.play-with-k8s.com/)
+* Understand how to [configure a Pod to use a ConfigMap](/docs/tasks/configure-pod-container/configure-pod-configmap/).


Existing formatting seems fine to me, so an explanation of why you find it not usable would be helpful.

Rewrite Configuring Redis using a ConfigMap

f5f295d

Rewrote the following documents for clarity: - Configuring Redis using a ConfigMap - Prerequisites doc

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Nov 14, 2024

k8s-ci-robot added the language/en Issues or PRs related to English language label Nov 14, 2024

k8s-ci-robot requested review from salaxander and windsonsea November 14, 2024 03:31

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. 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 Nov 14, 2024

Update configure-redis-using-configmap.md

0038e46

Fix grammar issue

jerry-li-dev added 2 commits November 14, 2024 02:23

Update configure-redis-using-configmap.md

6281790

Fix grammar issue

Merge branch 'rewrite-config-redis-with-configmap' of https://github.…

0a65f05

…com/jerry-li-dev/website into rewrite-config-redis-with-configmap

jihoon-seo reviewed Nov 18, 2024

View reviewed changes

stmcginnis reviewed Nov 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rewrite Configuring Redis using a ConfigMap #48716

Rewrite Configuring Redis using a ConfigMap #48716

jerry-li-dev commented Nov 14, 2024

linux-foundation-easycla bot commented Nov 14, 2024 •

edited

Loading

k8s-ci-robot commented Nov 14, 2024

k8s-ci-robot commented Nov 14, 2024

jerry-li-dev commented Nov 14, 2024

T-Lakshmi commented Nov 14, 2024

T-Lakshmi commented Nov 14, 2024

T-Lakshmi commented Nov 14, 2024 •

edited

Loading

jerry-li-dev commented Nov 14, 2024

k8s-ci-robot commented Nov 14, 2024

jihoon-seo left a comment

jihoon-seo Nov 18, 2024

jerry-li-dev Nov 18, 2024 •

edited

Loading

network-charles Nov 20, 2024

stmcginnis Nov 20, 2024

stmcginnis left a comment

stmcginnis Nov 20, 2024

stmcginnis Nov 20, 2024

stmcginnis Nov 20, 2024

stmcginnis Nov 20, 2024

stmcginnis Nov 20, 2024


		- Kubernetes cluster
		- kubectl command-line tool (`kubectl` 1.14 and above) configured to communicate with your cluster.

Rewrite Configuring Redis using a ConfigMap #48716

Are you sure you want to change the base?

Rewrite Configuring Redis using a ConfigMap #48716

Conversation

jerry-li-dev commented Nov 14, 2024

Description

Issue

linux-foundation-easycla bot commented Nov 14, 2024 • edited Loading

k8s-ci-robot commented Nov 14, 2024

k8s-ci-robot commented Nov 14, 2024

jerry-li-dev commented Nov 14, 2024

T-Lakshmi commented Nov 14, 2024

T-Lakshmi commented Nov 14, 2024

T-Lakshmi commented Nov 14, 2024 • edited Loading

jerry-li-dev commented Nov 14, 2024

k8s-ci-robot commented Nov 14, 2024

jihoon-seo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jerry-li-dev Nov 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stmcginnis 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

linux-foundation-easycla bot commented Nov 14, 2024 •

edited

Loading

T-Lakshmi commented Nov 14, 2024 •

edited

Loading

jerry-li-dev Nov 18, 2024 •

edited

Loading