-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[DOCS] Clarify upgrades and edit generally #3138
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
Conversation
🔍 Preview links for changed docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the Python client documentation to improve clarity, structure, and accuracy. The changes modernize the content with better explanations of compatibility, feature descriptions, and client usage.
- Added navigation metadata and improved page title
- Updated compatibility section with a clearer table and explanations
- Reorganized content flow with better placement of examples and tips
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@marciw The lint failure is unrelated, I'll fix that separately. |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
The backport to To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.0 9.0
# Navigate to the new working tree
cd .worktrees/backport-9.0
# Create a new branch
git switch --create backport-3138-to-9.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 06f25a0f370c21e511b75e02a87d3e7056e2a00e
# Push it to GitHub
git push --set-upstream origin backport-3138-to-9.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.0Then, create a pull request where the |
* Revise upgrade section; do a general edit * fix mis-paste * More edits * Review comments + more cleanup (cherry picked from commit 06f25a0)
* Revise upgrade section; do a general edit * fix mis-paste * More edits * Review comments + more cleanup (cherry picked from commit 06f25a0)
👁️ Preview docs/reference/index.md
Summary of changes
❗ Notes for reviewers
TODO
Clarify "outages" (whether clients need hot-swapping during major upgrades) per Upgrade from 7.17 guide docs-content#3398 (comment)<-- will do this in a follow-up issue; going to merge this in its current state as a "phase 1" edit