Skip to content

docs: Fix typos and grammar issues in markdown files #8306

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

cluster2600
Copy link

What does the PR do?

Fixes multiple typos, protocol misreferences, and documentation inconsistencies across the deployment and documentation files. These corrections improve clarity and correctness, especially in AWS and MLflow-related sections.

Checklist

  • I have read the Contribution guidelines and signed the Contributor License Agreement
  • PR title reflects the change and is of format docs: fix typos and clarify MLflow usage
  • Changes are described in the pull request.
  • Related issues are referenced.
  • Populated github labels field
  • Added test plan and verified test passes.
  • Verified that the PR passes existing CI.
  • I ran pre-commit locally (pre-commit install, pre-commit run --all)
  • Verified copyright is correct on all changed files.
  • Added succinct git squash message before merging ref.
  • All template sections are filled out.
  • Optional: Additional screenshots for behavior/output changes with before/after.

Commit Type:

  • docs

Related PRs:

Where should the reviewer start?

  • docs/aws/deployment.md
  • docs/mlflow/README.md
  • deployment/docker/*
  • Any other file with updated typos

Test plan:

  • Verified that all Markdown and config files still render/parse correctly
  • Ran pre-commit and verified no warnings or formatting issues
  • Confirmed CI passes (spelling/documentation changes only)

Caveats:

  • No functional code changes, only documentation and text fixes
  • Some cloud protocol corrections assume AWS backend (e.g. s3://)—please double-check for multi-cloud contexts

Background

This change addresses multiple small inconsistencies found while reading through the deployment documentation and configuration files, aiming to reduce confusion and improve documentation quality.

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

  • Closes GitHub issue: none formally filed

- Fix "SECRECT_KEY_ID" → "SECRET_KEY_ID" across multiple deploy files
- Fix "HTP/2" → "HTTP/2" protocol reference
- Fix cloud storage protocol "gs://" → "s3://" in AWS documentation
- Fix spelling errors: "Prpmetheus", "premissions", "rrequirement", "Buillding", "costomize"
- Fix grammar issues: missing commas, words, and duplicated text
- Clarify MLflow documentation section headers for CLI vs Python API

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant