-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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 admonitions to new shortcode format #14735
Conversation
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-14735-to-release-3.2.x origin/release-3.2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 3d6d35e97619f369182373bf25962494634fe653 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-14735-to-release-3.2.x
# Create the PR body template
PR_BODY=$(gh pr view 14735 --json body --template 'Backport 3d6d35e97619f369182373bf25962494634fe653 from #14735{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: update admonitions to new shortcode format (backport release-3.2.x)' --body-file - --label 'size/L' --label 'type/docs' --label 'backport' --base release-3.2.x --milestone release-3.2.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-14735-to-release-3.2.x
# Create a pull request where the `base` branch is `release-3.2.x` and the `compare`/`head` branch is `backport-14735-to-release-3.2.x`.
# Remove the local backport branch
git switch main
git branch -D backport-14735-to-release-3.2.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-14735-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 3d6d35e97619f369182373bf25962494634fe653 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-14735-to-release-3.1.x
# Create the PR body template
PR_BODY=$(gh pr view 14735 --json body --template 'Backport 3d6d35e97619f369182373bf25962494634fe653 from #14735{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: update admonitions to new shortcode format (backport release-3.1.x)' --body-file - --label 'size/L' --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-14735-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-14735-to-release-3.1.x`.
# Remove the local backport branch
git switch main
git branch -D backport-14735-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-14735-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 3d6d35e97619f369182373bf25962494634fe653 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-14735-to-release-3.0.x
# Create the PR body template
PR_BODY=$(gh pr view 14735 --json body --template 'Backport 3d6d35e97619f369182373bf25962494634fe653 from #14735{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: update admonitions to new shortcode format (backport release-3.0.x)' --body-file - --label 'size/L' --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-14735-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-14735-to-release-3.0.x`.
# Remove the local backport branch
git switch main
git branch -D backport-14735-to-release-3.0.x |
(cherry picked from commit 3d6d35e)
(cherry picked from commit 3d6d35e)
(cherry picked from commit 3d6d35e)
(cherry picked from commit 3d6d35e)
(cherry picked from commit 3d6d35e)
What this PR does / why we need it:
The format of the admonition shortcode changed a while back and I end up correcting this in a lot of PRs. Since I think many people probably copy and paste from an existing shortcode that they find in the files, I'm updating all of the shortcodes to the correct format.