Skip to content

chore: Update deepin-manual resources#157

Merged
lzwind merged 1 commit into
linuxdeepin:masterfrom
dengzhongyuan365-dev:master
Jul 8, 2025
Merged

chore: Update deepin-manual resources#157
lzwind merged 1 commit into
linuxdeepin:masterfrom
dengzhongyuan365-dev:master

Conversation

@dengzhongyuan365-dev
Copy link
Copy Markdown
Contributor

@dengzhongyuan365-dev dengzhongyuan365-dev commented Jul 8, 2025

  • Update deepin-manaual resources

log: Update deepin-manaual resources

Summary by Sourcery

Update deepin-diskmanager manual resources by reorganizing file names, cleaning up image references, and adding complete localized documentation pages.

Enhancements:

  • Rename and realign existing zh_TW disk-manager markdown file and remove obsolete figure tags in zh_TW and zh_HK content.

Documentation:

  • Add full localized manual files (p_disk-manager.md) for zh_HK, zh_CN, zh_TW, and en_US to provide comprehensive multi-language documentation.

- Update deepin-manaual resources

log: Update deepin-manaual resources
@deepin-ci-robot
Copy link
Copy Markdown

deepin pr auto review

代码审查结果如下:

  1. 文件重命名:将 disk-manager.md 重命名为 d_disk-manager.md,这可能是为了遵循某种命名规范或避免与现有文件冲突。确认是否有必要进行此重命名操作。

  2. 新增文件:新增了 p_disk-manager.md 文件,但文件内容与 disk-manager.md 相同。确认是否有必要创建此文件,以及是否需要更新文件内容。

  3. 文件内容:文件内容主要是磁盘管理器的使用说明,包括运行、关闭、创建桌面快捷方式等操作,以及磁盘管理的基本操作,如查看磁盘信息、创建分区表、运行健康管理等。确认文件内容是否完整、准确,是否有遗漏或错误。

  4. 图片引用:文件中引用了多个图片,如 fig/password.pngfig/disk_main_interface.png 等。确认这些图片是否存在于项目中,以及图片路径是否正确。

  5. 注意事项:文件中多次出现 ![attention](../common/attention.svg),表示需要注意的事项。确认这些注意事项是否准确,是否有遗漏或错误。

  6. 代码风格:文件中使用了 Markdown 语法,整体风格一致。确认是否有必要进行代码风格调整,以提高可读性和一致性。

  7. 代码注释:文件中包含了一些注释,如 >![attention](../common/attention.svg) 注意:,用于解释某些操作的风险或注意事项。确认注释是否准确,是否有遗漏或错误。

  8. 代码错误:文件中没有明显的语法或逻辑错误。确认是否有必要进行代码错误检查,以及是否需要修复潜在的错误。

  9. 代码优化:文件中的一些操作,如创建分区表、调整分区空间、擦除磁盘或分区等,可能需要优化以提高性能和用户体验。确认是否有必要进行代码优化。

  10. 代码安全:文件中涉及到用户输入密码的操作,需要确保密码的安全性。确认是否有必要进行代码安全检查,以及是否需要采取安全措施来保护用户数据。

总体来说,文件内容较为完整,但可能需要进一步优化和检查以确保代码质量和用户体验。

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Jul 8, 2025

Reviewer's Guide

This PR reorganizes and updates the disk manager documentation by cleaning up outdated figure references, standardizing filenames, and introducing brand-new, comprehensive localized manual files.

File-Level Changes

Change Details Files
Cleaned up inline figure references in existing localization docs
  • Removed placeholder lines for startverify, stopverify, and wipe images
  • Eliminated redundant blank lines around those sections
application/assets/deepin-diskmanager/disk-manager/zh_TW/disk-manager.md
application/assets/deepin-diskmanager/disk-manager/zh_HK/disk-manager.md
Renamed disk-manager markdown assets for consistency
  • Prefixed existing disk-manager.md files with 'd_' in zh_TW and zh_HK locales
  • Updated references and paths to match the new filenames
application/assets/deepin-diskmanager/disk-manager/zh_TW/d_disk-manager.md
application/assets/deepin-diskmanager/disk-manager/zh_HK/d_disk-manager.md
Added new comprehensive localized manual files
  • Introduced p_disk-manager.md in each locale as a full user guide
  • Populated each with complete command descriptions and UI workflows
application/assets/deepin-diskmanager/disk-manager/zh_HK/p_disk-manager.md
application/assets/deepin-diskmanager/disk-manager/zh_CN/p_disk-manager.md
application/assets/deepin-diskmanager/disk-manager/zh_TW/p_disk-manager.md
application/assets/deepin-diskmanager/disk-manager/en_US/p_disk-manager.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @dengzhongyuan365-dev - I've reviewed your changes - here's some feedback:

  • The removal of image references (e.g., ![0|startverify], ![0|format]) will break figure rendering—please confirm those deletions are intentional or restore the correct links.
  • The newly added locale docs use a p_disk-manager.md filename prefix instead of the existing disk-manager.md convention—please align naming or update your docs config so these files load correctly.
  • There are minor formatting inconsistencies (list markers and indentation) across the added translation files—please run a markdown formatter to keep styling uniform.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The removal of image references (e.g., `![0|startverify]`, `![0|format]`) will break figure rendering—please confirm those deletions are intentional or restore the correct links.
- The newly added locale docs use a `p_disk-manager.md` filename prefix instead of the existing `disk-manager.md` convention—please align naming or update your docs config so these files load correctly.
- There are minor formatting inconsistencies (list markers and indentation) across the added translation files—please run a markdown formatter to keep styling uniform.

## Individual Comments

### Comment 1
<location> `application/assets/deepin-diskmanager/disk-manager/en_US/p_disk-manager.md:152` </location>
<code_context>
+
+1. On the Disk Utility interface, select a disk or partition and click the Wipe ![erase](../common/erase.svg) icon on the top toolbar.
+2. A wiping interface pops up. Fill in the name and select the file system and security option. AES / SM4 encryption is supported. There are three security options, namely Fast, Secure and Advanced, with the Fast option as the default.
+   - Fast:  It only deletes the partition info without erasing the files on the disk. Disk recover tools may recover the files with a certain probabality.
+   - Secure: It is a one-time secure wipe that complies with NIST 800-88 and writes 0, 1, and random data to the entire disk once. You will not be able to recover files, and the process will be slow.
+   - Advanced: There are two wiping methods, namely DoD 5220.22-M and Gutmann. It writes 0, 1, and random data to the entire disk several times. You can set the number of times to wipe disks and overwrite data, but the process will be very slow.
</code_context>

<issue_to_address>
Typo: 'probabality' should be 'probability'.

Please update 'probabality' to 'probability' in the text.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
   - Fast:  It only deletes the partition info without erasing the files on the disk. Disk recover tools may recover the files with a certain probabality.
=======
   - Fast:  It only deletes the partition info without erasing the files on the disk. Disk recover tools may recover the files with a certain probability.
>>>>>>> REPLACE

</suggested_fix>

### Comment 2
<location> `application/assets/deepin-diskmanager/disk-manager/zh_TW/p_disk-manager.md:298` </location>
<code_context>
+
+掛載邏輯卷與掛載分區操作類似,詳細操作請參考磁碟管理的 [掛載分區](#掛載分區)+
+#### 移除邏輯卷
+
+移除邏輯卷組與移除分區操作類似,詳細操作請參考磁碟管理的 [移除分區](#移除分區)。
</code_context>

<issue_to_address>
Section heading may be confusing: '移除邏輯卷組與移除分區操作類似'.

The section discusses removing a logical volume, but the heading and text mention removing a volume group. Please update the wording for accuracy.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
#### 移除邏輯卷

移除邏輯卷組與移除分區操作類似,詳細操作請參考磁碟管理的 [移除分區](#移除分區)=======
#### 移除邏輯卷

移除邏輯卷與移除分區操作類似,詳細操作請參考磁碟管理的 [移除分區](#移除分區)>>>>>>> REPLACE

</suggested_fix>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.


1. On the Disk Utility interface, select a disk or partition and click the Wipe ![erase](../common/erase.svg) icon on the top toolbar.
2. A wiping interface pops up. Fill in the name and select the file system and security option. AES / SM4 encryption is supported. There are three security options, namely Fast, Secure and Advanced, with the Fast option as the default.
- Fast: It only deletes the partition info without erasing the files on the disk. Disk recover tools may recover the files with a certain probabality.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (typo): Typo: 'probabality' should be 'probability'.

Please update 'probabality' to 'probability' in the text.

Suggested change
- Fast: It only deletes the partition info without erasing the files on the disk. Disk recover tools may recover the files with a certain probabality.
- Fast: It only deletes the partition info without erasing the files on the disk. Disk recover tools may recover the files with a certain probability.

Comment on lines +298 to +300
#### 移除邏輯卷

移除邏輯卷組與移除分區操作類似,詳細操作請參考磁碟管理的 [移除分區](#移除分區)。
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Section heading may be confusing: '移除邏輯卷組與移除分區操作類似'.

The section discusses removing a logical volume, but the heading and text mention removing a volume group. Please update the wording for accuracy.

Suggested change
#### 移除邏輯卷
移除邏輯卷組與移除分區操作類似,詳細操作請參考磁碟管理的 [移除分區](#移除分區)
#### 移除邏輯卷
移除邏輯卷與移除分區操作類似,詳細操作請參考磁碟管理的 [移除分區](#移除分區)

@lzwind lzwind merged commit c58d663 into linuxdeepin:master Jul 8, 2025
15 of 17 checks passed
@deepin-ci-robot
Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: dengzhongyuan365-dev, lzwind

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants