-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
docs: Update components.md #fix some typos #14612
Conversation
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.
[Docs team] Thanks for taking the time to update the docs.
@JStickler Can you take another look? |
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.
[docs team]
Co-authored-by: Christian Haudum <[email protected]> Co-authored-by: J Stickler <[email protected]> (cherry picked from commit a412009)
Co-authored-by: Christian Haudum <[email protected]> Co-authored-by: J Stickler <[email protected]> (cherry picked from commit a412009)
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-14612-to-release-3.1.x origin/release-3.1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x a412009d77de4d18ad2cb4d133338ee2b1155150 When the conflicts are resolved, stage and commit the changes:
If you have the GitHub CLI installed: # Push the branch to GitHub:
git push --set-upstream origin backport-14612-to-release-3.1.x
# Create the PR body template
PR_BODY=$(gh pr view 14612 --json body --template 'Backport a412009d77de4d18ad2cb4d133338ee2b1155150 from #14612{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: Update components.md #fix some typos (backport release-3.1.x)' --body-file - --label 'size/S' --label 'type/docs' --label 'backport' --base release-3.1.x --milestone release-3.1.x --web Or, if you don't have the GitHub CLI installed (we recommend you install it!): # Push the branch to GitHub:
git push --set-upstream origin backport-14612-to-release-3.1.x
# Create a pull request where the `base` branch is `release-3.1.x` and the `compare`/`head` branch is `backport-14612-to-release-3.1.x`.
# Remove the local backport branch
git switch main
git branch -D backport-14612-to-release-3.1.x |
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-14612-to-release-3.0.x origin/release-3.0.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x a412009d77de4d18ad2cb4d133338ee2b1155150 When the conflicts are resolved, stage and commit the changes:
If you have the GitHub CLI installed: # Push the branch to GitHub:
git push --set-upstream origin backport-14612-to-release-3.0.x
# Create the PR body template
PR_BODY=$(gh pr view 14612 --json body --template 'Backport a412009d77de4d18ad2cb4d133338ee2b1155150 from #14612{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: Update components.md #fix some typos (backport release-3.0.x)' --body-file - --label 'size/S' --label 'type/docs' --label 'backport' --base release-3.0.x --milestone release-3.0.x --web Or, if you don't have the GitHub CLI installed (we recommend you install it!): # Push the branch to GitHub:
git push --set-upstream origin backport-14612-to-release-3.0.x
# Create a pull request where the `base` branch is `release-3.0.x` and the `compare`/`head` branch is `backport-14612-to-release-3.0.x`.
# Remove the local backport branch
git switch main
git branch -D backport-14612-to-release-3.0.x |
Co-authored-by: Christian Haudum <[email protected]> Co-authored-by: J Stickler <[email protected]> (cherry picked from commit a412009)
Co-authored-by: Christian Haudum <[email protected]> Co-authored-by: J Stickler <[email protected]> (cherry picked from commit a412009)
Co-authored-by: Piyush Bhaskar <[email protected]>
Co-authored-by: Piyush Bhaskar <[email protected]>
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Checklist
CONTRIBUTING.md
guide (required)feat
PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/sources/setup/upgrade/_index.md
deprecated-config.yaml
anddeleted-config.yaml
files respectively in thetools/deprecated-config-checker
directory. Example PR