Skip to content
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

[Doc] fix descriptions, add guide link (backport #54620) #54624

Closed
wants to merge 1 commit into from

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jan 2, 2025

  • Add tip "see the overview guide..." to top of the backup, create repository, and restore docs
  • Remove unused mdx files
  • remove the line ## Description from each file so that the overview page has descriptions for each doc instead of the word Description

What type of PR is this:

  • BugFix
  • Feature
  • Enhancement
  • Refactor
  • UT
  • Doc
  • Tool

Does this PR entail a change in behavior?

  • Yes, this PR will result in a change in behavior.
  • No, this PR will not result in a change in behavior.

If yes, please specify the type of change:

  • Interface/UI changes: syntax, type conversion, expression evaluation, display information
  • Parameter changes: default values, similar parameters but with different default values
  • Policy changes: use new policy to replace old one, functionality automatically enabled
  • Feature removed
  • Miscellaneous: upgrade & downgrade compatibility, etc.

Checklist:

  • I have added test cases for my bug fix or my new feature
  • This pr needs user documentation (for new or modified features or behaviors)
    • I have added documentation for my new feature or new function
  • This is a backport pr

(cherry picked from commit dc79ada)

# Conflicts:
#	docs/en/sql-reference/sql-statements/backup_restore/BACKUP.md
#	docs/en/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md
#	docs/en/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md
#	docs/en/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md
#	docs/en/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md
#	docs/en/sql-reference/sql-statements/backup_restore/RESTORE.md
#	docs/en/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md
#	docs/en/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md
#	docs/zh/overview-pages/other-data-types.mdx
#	docs/zh/sql-reference/sql-statements/backup_restore/BACKUP.md
#	docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md
#	docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md
#	docs/zh/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md
#	docs/zh/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md
#	docs/zh/sql-reference/sql-statements/backup_restore/RESTORE.md
#	docs/zh/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md
#	docs/zh/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md
#	docs/zh/sql-reference/sql-statements/backup_restore/backup_restore.mdx
Copy link
Contributor Author

mergify bot commented Jan 2, 2025

Cherry-pick of dc79ada has failed:

On branch mergify/bp/branch-3.1/pr-54620
Your branch is up to date with 'origin/branch-3.1'.

You are currently cherry-picking commit dc79ada1d7.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   docs/en/sql-reference/sql-statements/backup_restore/RECOVER.md
	modified:   docs/en/sql-reference/sql-statements/backup_restore/SHOW_REPOSITORIES.md
	modified:   docs/en/sql-reference/sql-statements/backup_restore/SHOW_SNAPSHOT.md
	modified:   docs/zh/sql-reference/sql-statements/backup_restore/RECOVER.md
	modified:   docs/zh/sql-reference/sql-statements/backup_restore/SHOW_REPOSITORIES.md

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   docs/en/sql-reference/sql-statements/backup_restore/BACKUP.md
	both modified:   docs/en/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md
	both modified:   docs/en/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md
	both modified:   docs/en/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md
	both modified:   docs/en/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md
	both modified:   docs/en/sql-reference/sql-statements/backup_restore/RESTORE.md
	both modified:   docs/en/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md
	both modified:   docs/en/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md
	deleted by them: docs/zh/overview-pages/other-data-types.mdx
	both modified:   docs/zh/sql-reference/sql-statements/backup_restore/BACKUP.md
	both modified:   docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_BACKUP.md
	both modified:   docs/zh/sql-reference/sql-statements/backup_restore/CANCEL_RESTORE.md
	both modified:   docs/zh/sql-reference/sql-statements/backup_restore/CREATE_REPOSITORY.md
	both modified:   docs/zh/sql-reference/sql-statements/backup_restore/DROP_REPOSITORY.md
	both modified:   docs/zh/sql-reference/sql-statements/backup_restore/RESTORE.md
	both modified:   docs/zh/sql-reference/sql-statements/backup_restore/SHOW_BACKUP.md
	both modified:   docs/zh/sql-reference/sql-statements/backup_restore/SHOW_RESTORE.md
	deleted by them: docs/zh/sql-reference/sql-statements/backup_restore/backup_restore.mdx

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot added the conflicts label Jan 2, 2025
@mergify mergify bot mentioned this pull request Jan 2, 2025
24 tasks
@github-actions github-actions bot added documentation Improvements or additions to documentation automerge labels Jan 2, 2025
@wanpengfei-git wanpengfei-git enabled auto-merge (squash) January 2, 2025 23:16
@mergify mergify bot closed this Jan 2, 2025
auto-merge was automatically disabled January 2, 2025 23:16

Pull request was closed

Copy link
Contributor Author

mergify bot commented Jan 2, 2025

@mergify[bot]: Backport conflict, please reslove the conflict and resubmit the pr

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge conflicts documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant