Add Introduction to Kubernetes Docs with YAML basics and Suggested Resources #7
Conversation
|
@mansurianas is attempting to deploy a commit to the devsuraj Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThis update restructures the Kubernetes documentation by deleting two metadata-only files, revising the interview questions metadata to a structured array with ordering, and introducing a comprehensive introductory document on Kubernetes fundamentals, configuration, and learning resources. Changes
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
content/docs/Kubernetes/kubernets-docs/introduction.mdx (2)
75-75: Fix heading grammarInterrogative headings in English need the auxiliary verb before the subject:
-## Why YAML is Used in Kubernetes? +## Why Is YAML Used in Kubernetes?
37-46: Emojis inside tables hurt accessibility & fallback renderingScreen-readers will announce “emoji heavy check mark” etc., and some Markdown renderers drop coloured glyphs inside tables.
Consider replacing with plain “Yes / Partial / No” or ✅/❌ via text.Example:
-| Networking between containers | 🟡 Limited | ✅ | +| Networking between containers | Limited* | Yes |Add a footnote if you need to explain “Limited”.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (5)
content/docs/Kubernetes/InterviewQuestions/index.mdx(0 hunks)content/docs/Kubernetes/InterviewQuestions/meta.json(0 hunks)content/docs/Kubernetes/index.md(0 hunks)content/docs/Kubernetes/kubernets-docs/introduction.mdx(1 hunks)content/docs/Kubernetes/kubernets-docs/meta.json(1 hunks)
💤 Files with no reviewable changes (3)
- content/docs/Kubernetes/InterviewQuestions/index.mdx
- content/docs/Kubernetes/index.md
- content/docs/Kubernetes/InterviewQuestions/meta.json
🧰 Additional context used
🪛 LanguageTool
content/docs/Kubernetes/kubernets-docs/introduction.mdx
[uncategorized] ~22-~22: The verb “was” doesn’t seem to fit in this context, “were” is probably more formally correct.
Context: ...ing - Scaling containers across servers was complex - Rolling updates required manu...
(AI_HYDRA_LEO_CPT_WAS_WERE)
[style] ~24-~24: To elevate your writing, try using a synonym here.
Context: ...rvice discovery and load balancing were hard to manage Kubernetes solves these by: ...
(HARD_TO)
[uncategorized] ~24-~24: A period might be missing here.
Context: ...scovery and load balancing were hard to manage Kubernetes solves these by: - Automat...
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
[uncategorized] ~35-~35: Possible missing article found.
Context: ...Kubernetes builds on Docker by managing container lifecycle at scale. | Feature ...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~54-~54: A determiner appears to be missing. Consider inserting it.
Context: ...ntages of Kubernetes - Complexity: Learning curve is steep, especially for beginner...
(AI_EN_LECTOR_MISSING_DETERMINER)
[grammar] ~75-~75: If this is a question, the word order is probably incorrect. Did you mean “Why is YAML”… ?
Context: ...then tries to make that state real. ## Why YAML is Used in Kubernetes? - ✅ **Human-readab...
(WHY_THE_WORD_ORDER_IS_WRONG)
| [ | ||
|
|
||
| { | ||
| "title": "introduction", | ||
| "position": 1 | ||
|
|
||
| }, | ||
| { | ||
| "title": "architecture", | ||
| "position": 2 | ||
| } | ||
| ] No newline at end of file |
There was a problem hiding this comment.
Directory name is misspelled – will break generated routes & links
The file sits under kubernets-docs/, missing an “e”. All sidebar paths, MDX import links and any slug generation that relies on the physical directory name will silently break.
-content/docs/Kubernetes/kubernets-docs/
+content/docs/Kubernetes/kubernetes-docs/Rename the folder (and update any references) before this lands on main.
Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In content/docs/Kubernetes/kubernets-docs/meta.json lines 1 to 12, the directory
name "kubernets-docs" is misspelled and should be corrected to
"kubernetes-docs". Rename the folder to fix the typo and update all references
to this directory in sidebar paths, MDX import links, and any slug generation
logic to prevent broken routes and links.
|
|
||
| ## Conclusion | ||
|
|
||
| Docker sirf ek chhota part hai (container runtime). Kubernetes us container ko manage karta hai — production-ready orchestration system. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Avoid mixing Hindi with English – keep docs language consistent
The sentence mixes Hindi (“sirf ek chhota part hai …”) with English, which can confuse readers and breaks the style of the rest of the docs.
-Docker sirf ek chhota part hai (container runtime). Kubernetes us container ko manage karta hai — production-ready orchestration system.
+Docker is only one piece of the puzzle (the container runtime).
+Kubernetes manages those containers, providing a production-ready orchestration platform.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Docker sirf ek chhota part hai (container runtime). Kubernetes us container ko manage karta hai — production-ready orchestration system. | |
| Docker is only one piece of the puzzle (the container runtime). | |
| Kubernetes manages those containers, providing a production-ready orchestration platform. |
🤖 Prompt for AI Agents
In content/docs/Kubernetes/kubernets-docs/introduction.mdx at line 50, the
sentence mixes Hindi and English, which disrupts the document's language
consistency. Rewrite the sentence entirely in English to maintain a consistent
language style throughout the documentation.
|
Hi @mansurianas thanks for raising PR. and also add the proper chennel links etc.. of these as well: |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
content/docs/Kubernetes/InterviewQuestions/meta.json (1)
4-6: Capitalize titles for consistency
"introduction"/"architecture"differ from previously Title-cased"Interview Questions". Switch to"Introduction"/"Architecture"to keep headings uniform.- "title": "introduction", + "title": "Introduction", ... - "title": "architecture", + "title": "Architecture",content/docs/Kubernetes/InterviewQuestions/introduction.mdx (4)
50-51: Avoid mixed-language sentenceThe Hindi phrase may confuse non-Hindi readers. Replace with an English equivalent or provide translation.
- Docker sirf ek chhota part hai (container runtime). Kubernetes us container ko manage karta hai — production-ready orchestration system. + Docker is only a small part of the story (it’s the container runtime). Kubernetes manages those containers — it is the production-ready orchestration system.
75-77: Correct the heading grammarInterrogative headings should invert subject/verb order.
-## Why YAML is Used in Kubernetes? +## Why Is YAML Used in Kubernetes?
85-91: Small wording fixes & punctuationMinor style/grammar adjustments for clarity.
- - **Indentation:** Always use spaces, not tabs. Usually 2 spaces. + - **Indentation:** Always use spaces, not tabs — commonly 2 spaces. - - **Key-value pairs:** Use key: value format + - **Key–value pairs:** Use `key: value` format. - - **Start of a YAML doc:** Use --- (3 dashes) to indicate start of YAML file + - **Document start:** Use `---` (three dashes) to mark the beginning of a YAML file.
117-129: Add clickable links for all referenced platformsOnly Killercoda is linked; KodeKloud isn’t. Add its URL to maintain parity.
-Platforms like **Killercoda** and **KodeKloud** offer interactive Kubernetes labs. +Platforms like **[Killercoda](https://killercoda.com/)** and **[KodeKloud](https://kodekloud.com/)** offer interactive Kubernetes labs.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/docs/Kubernetes/InterviewQuestions/introduction.mdx(1 hunks)content/docs/Kubernetes/InterviewQuestions/meta.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/docs/Kubernetes/InterviewQuestions/introduction.mdx
[uncategorized] ~22-~22: The verb “was” doesn’t seem to fit in this context, “were” is probably more formally correct.
Context: ...ing - Scaling containers across servers was complex - Rolling updates required manu...
(AI_HYDRA_LEO_CPT_WAS_WERE)
[style] ~24-~24: To elevate your writing, try using a synonym here.
Context: ...rvice discovery and load balancing were hard to manage Kubernetes solves these by: ...
(HARD_TO)
[uncategorized] ~24-~24: A period might be missing here.
Context: ...scovery and load balancing were hard to manage Kubernetes solves these by: - Automat...
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
[uncategorized] ~35-~35: Possible missing article found.
Context: ...Kubernetes builds on Docker by managing container lifecycle at scale. | Feature ...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~54-~54: A determiner appears to be missing. Consider inserting it.
Context: ...ntages of Kubernetes - Complexity: Learning curve is steep, especially for beginner...
(AI_EN_LECTOR_MISSING_DETERMINER)
[grammar] ~75-~75: If this is a question, the word order is probably incorrect. Did you mean “Why is YAML”… ?
Context: ...then tries to make that state real. ## Why YAML is Used in Kubernetes? - ✅ **Human-readab...
(WHY_THE_WORD_ORDER_IS_WRONG)
🔇 Additional comments (1)
content/docs/Kubernetes/InterviewQuestions/meta.json (1)
1-12: Confirm array format in Kubernetes InterviewQuestions meta.jsonVerified that
content/docs/Kubernetes/InterviewQuestions/meta.jsonuses a top-level JSON array, while every othermeta.json(including otherInterviewQuestionsdirectories) starts with an object ({). If the sidebar builder or custom script expects the single-object shape, this change could break ordering or visibility. Please confirm that Docusaurus (or your sidebar generator) supports a root array inmeta.json, or adjust this file back to the object format.
|
I've made the requested changes: Restored the deleted folders (InterviewQuestions, etc.) Followed your folder-based structure and notes format Added YouTube links and updated content accordingly Attached below is the screenshot of the updated website view after the changes
|
|
Hi Anas, as we discussed and I have explained that you don't have to delete any file that is initially present okay so you deleted the. the text you're seeing introduction to kubernetes it should in the index.mdx under the kuberentes folder. See the structure i have here. For the introduction part you have to add all the infromation under okay And as I have made the folder for the interview preparation and have two files these files: Like this you have to make for every topics of kuberentes like k8s resources pods, deployments, services etc... Do you now understand this? please clone it again and make the changes because you don't need to delete anything that exists initially. |
2 participants
Description
This PR adds a detailed introduction to Kubernetes as part of the documentation initiative. It includes:
Why Kubernetes was created
Difference between Docker and Kubernetes
YAML basics for Kubernetes resources
A fully commented example YAML for Pod
Suggested learning resources (Killercoda, YouTube, Official docs)
Type of Change
📝 Documentation update
Changes Made
Created introduction.mdx under content/docs/Kubernetes/kubernets-docs/
Wrote and formatted Kubernetes overview + YAML basics
Added meta.json with sidebar positions
Removed outdated InterviewQuestions/ directory and index.md
Summary by CodeRabbit
New Features
Documentation