Markdown linting and Langauge fixes #123
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jbrejner
force-pushed
the
jbrejner/markdown_lint_and_grammar
branch
from
04b0ea5 to
1ac2c2a
Compare
jbrejner
force-pushed
the
jbrejner/markdown_lint_and_grammar
branch
from
1ac2c2a to
0b659df
Compare
jbrejner
force-pushed
the
jbrejner/markdown_lint_and_grammar
branch
from
ca7e1f2 to
78097aa
Compare
michaelin
reviewed
Aug 21, 2025
jbrejner
force-pushed
the
jbrejner/markdown_lint_and_grammar
branch
from
1ed7ef5 to
c987da5
Compare
There was a problem hiding this comment.
Pull Request Overview
This pull request improves Kubernetes documentation clarity and consistency across multiple files. The changes focus on grammar corrections, comma usage improvements, and standardized terminology throughout the guides.
Key changes:
- Grammar and punctuation improvements for better readability
- Standardized terminology (e.g., "PostgreSQL" instead of "postgres", "step-by-step" consistently)
- Enhanced explanations of technical concepts and procedures
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| services.md | Improved clarity in service discovery explanations and corrected grammar throughout |
| rolling-updates.md | Enhanced rollout instructions and corrected grammar in deployment update procedures |
| persistent-storage.md | Standardized PostgreSQL terminology and improved persistence concept explanations |
| manifests.md | Minor grammar corrections in manifest application instructions |
| intro.md | Improved application deployment explanations and access instructions |
| exercise-template.md | Corrected spelling and improved template structure guidance |
| desired-state.md | Enhanced desired state concept explanations and controller descriptions |
| deployments-ingress.md | Improved deployment and load balancing terminology |
| configmaps-secrets.md | Enhanced ConfigMap and Secret usage explanations |
| cheatsheet.md | Corrected spelling in kubectl command documentation |
| accessing-your-application.md | Improved port-forwarding explanations and step-by-step instructions |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Michael Ingeman-Nielsen <[email protected]>
jbrejner
force-pushed
the
jbrejner/markdown_lint_and_grammar
branch
from
6d54b9e to
c55c34a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates multiple Kubernetes documentation files to improve clarity, grammar, and consistency. The changes focus on making instructions easier to follow, correcting typos, and standardizing terminology across the guides.
Documentation improvements:
accessing-your-application.md, including improved explanations of port-forwarding, step-by-step instructions, and environment variable usage. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]configmaps-secrets.md, including clear distinctions between configmaps and secrets, better step-by-step instructions, and more precise descriptions of YAML manifests and environment variable injection. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]Terminology and consistency fixes:
cheatsheet.md, such as "Documentation" and "resource types and abbreviations."deployments-ingress.md, such as clarifying "load balancing" and using "higher-level abstraction." [1] [2]